001/*
002 * Copyright 2014-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2014-2020 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2014-2020 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.listener.interceptor;
037
038
039
040import com.unboundid.ldap.sdk.ExtendedResult;
041import com.unboundid.ldap.sdk.LDAPException;
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class provides an API that can be used in the course of processing a
050 * result via the {@link InMemoryOperationInterceptor} API.
051 */
052@NotExtensible()
053@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
054public interface InMemoryInterceptedResult
055{
056  /**
057   * Retrieves the connection ID for the associated client connection.
058   *
059   * @return  The connection ID for the associated client connection.
060   */
061  long getConnectionID();
062
063
064
065  /**
066   * Retrieves the server address to which the client is connected, if
067   * available.
068   *
069   * @return  The server address to which the client is connected, or
070   *          {@code null} if this is not available for some reason.
071   */
072  String getConnectedAddress();
073
074
075
076  /**
077   * Retrieves the server port to which the client is connected, if available.
078   *
079   * @return  The server port to which the client is connected, or -1 if this is
080   *          not available for some reason.
081   */
082  int getConnectedPort();
083
084
085
086  /**
087   * Retrieves the LDAP message ID for this operation.
088   *
089   * @return  The LDAP message ID for this operation.
090   */
091  int getMessageID();
092
093
094
095  /**
096   * Sends an unsolicited notification message to the client.
097   *
098   * @param  unsolicitedNotification  The unsolicited notification to send to
099   *                                  the client.  It must not be {@code null}.
100   *
101   * @throws  LDAPException  If a problem is encountered while trying to send
102   *                         the unsolicited notification.
103   */
104  void sendUnsolicitedNotification(ExtendedResult unsolicitedNotification)
105         throws LDAPException;
106
107
108
109  /**
110   * Retrieves the value for a property that has previously been set for this
111   * operation.  This can be used to help maintain state information across the
112   * request and response for an operation.
113   *
114   * @param  name  The name of the property for which to retrieve the
115   *               corresponding value.  It must not be {@code null}.
116   *
117   * @return  The value for the requested property, or {@code null} if there is
118   *          no value for the specified property.
119   */
120  Object getProperty(String name);
121}