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.LDAPException; 042import com.unboundid.util.NotExtensible; 043import com.unboundid.util.NotNull; 044import com.unboundid.util.Nullable; 045import com.unboundid.util.ThreadSafety; 046import com.unboundid.util.ThreadSafetyLevel; 047 048 049 050/** 051 * This class provides an API that can be used in the course of processing a 052 * result via the {@link InMemoryOperationInterceptor} API. 053 */ 054@NotExtensible() 055@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 056public interface InMemoryInterceptedResult 057{ 058 /** 059 * Retrieves the connection ID for the associated client connection. 060 * 061 * @return The connection ID for the associated client connection. 062 */ 063 long getConnectionID(); 064 065 066 067 /** 068 * Retrieves the server address to which the client is connected, if 069 * available. 070 * 071 * @return The server address to which the client is connected, or 072 * {@code null} if this is not available for some reason. 073 */ 074 @Nullable() 075 String getConnectedAddress(); 076 077 078 079 /** 080 * Retrieves the server port to which the client is connected, if available. 081 * 082 * @return The server port to which the client is connected, or -1 if this is 083 * not available for some reason. 084 */ 085 int getConnectedPort(); 086 087 088 089 /** 090 * Retrieves the LDAP message ID for this operation. 091 * 092 * @return The LDAP message ID for this operation. 093 */ 094 int getMessageID(); 095 096 097 098 /** 099 * Sends an unsolicited notification message to the client. 100 * 101 * @param unsolicitedNotification The unsolicited notification to send to 102 * the client. It must not be {@code null}. 103 * 104 * @throws LDAPException If a problem is encountered while trying to send 105 * the unsolicited notification. 106 */ 107 void sendUnsolicitedNotification( 108 @NotNull ExtendedResult unsolicitedNotification) 109 throws LDAPException; 110 111 112 113 /** 114 * Retrieves the value for a property that has previously been set for this 115 * operation. This can be used to help maintain state information across the 116 * request and response for an operation. 117 * 118 * @param name The name of the property for which to retrieve the 119 * corresponding value. It must not be {@code null}. 120 * 121 * @return The value for the requested property, or {@code null} if there is 122 * no value for the specified property. 123 */ 124 @Nullable() 125 Object getProperty(@NotNull String name); 126}