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