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.IntermediateResponse;
042import com.unboundid.ldap.sdk.LDAPException;
043import com.unboundid.util.NotExtensible;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class provides an API that can be used in the course of processing a
051 * request via the {@link InMemoryOperationInterceptor} API.
052 */
053@NotExtensible()
054@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
055public interface InMemoryInterceptedRequest
056{
057  /**
058   * Retrieves the connection ID for the associated client connection.
059   *
060   * @return  The connection ID for the associated client connection.
061   */
062  long getConnectionID();
063
064
065
066  /**
067   * Retrieves the server address to which the client is connected, if
068   * available.
069   *
070   * @return  The server address to which the client is connected, or
071   *          {@code null} if this is not available for some reason.
072   */
073  String getConnectedAddress();
074
075
076
077  /**
078   * Retrieves the server port to which the client is connected, if available.
079   *
080   * @return  The server port to which the client is connected, or -1 if this is
081   *          not available for some reason.
082   */
083  int getConnectedPort();
084
085
086
087  /**
088   * Retrieves the LDAP message ID for this operation.
089   *
090   * @return  The LDAP message ID for this operation.
091   */
092  int getMessageID();
093
094
095
096  /**
097   * Sends the provided intermediate response message to the client.  It will
098   * be processed by the
099   * {@link InMemoryOperationInterceptor#processIntermediateResponse} method of
100   * all registered operation interceptors.
101   *
102   * @param  intermediateResponse  The intermediate response to send to the
103   *                               client.  It must not be {@code null}.
104   *
105   * @throws  LDAPException  If a problem is encountered while trying to send
106   *                         the intermediate response.
107   */
108  void sendIntermediateResponse(IntermediateResponse intermediateResponse)
109       throws LDAPException;
110
111
112
113  /**
114   * Sends an unsolicited notification message to the client.
115   *
116   * @param  unsolicitedNotification  The unsolicited notification to send to
117   *                                  the client.  It must not be {@code null}.
118   *
119   * @throws  LDAPException  If a problem is encountered while trying to send
120   *                         the unsolicited notification.
121   */
122  void sendUnsolicitedNotification(ExtendedResult unsolicitedNotification)
123       throws LDAPException;
124
125
126
127  /**
128   * Retrieves the value for a property that has previously been set for this
129   * operation.  This can be used to help maintain state information across the
130   * request and response for an operation.
131   *
132   * @param  name  The name of the property for which to retrieve the
133   *               corresponding value.  It must not be {@code null}.
134   *
135   * @return  The value for the requested property, or {@code null} if there is
136   *          no value for the specified property.
137   */
138  Object getProperty(String name);
139
140
141
142  /**
143   * Sets the value for a property that may be used to help maintain state
144   * information across the request and response for an operation.
145   *
146   * @param  name   The name of the property to set.  It must not be
147   *                {@code null}.
148   * @param  value  The value to use for the property.  If it is {@code null},
149   *                then any value previously set will be removed.
150   *
151   * @return  The value held for the property before this method was invoked, or
152   *          {@code null} if it did not previously have a value.
153   */
154  Object setProperty(String name, Object value);
155}