com.unboundid.ldap.listener.interceptor

Interface InMemoryInterceptedResult

All Known Subinterfaces:

InMemoryInterceptedAddResult, InMemoryInterceptedCompareResult, InMemoryInterceptedDeleteResult, InMemoryInterceptedExtendedResult, InMemoryInterceptedIntermediateResponse, InMemoryInterceptedModifyDNResult, InMemoryInterceptedModifyResult, InMemoryInterceptedSASLBindResult, InMemoryInterceptedSearchEntry, InMemoryInterceptedSearchReference, InMemoryInterceptedSearchResult, InMemoryInterceptedSimpleBindResult

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface InMemoryInterceptedResult

This class provides an API that can be used in the course of processing a result via the InMemoryOperationInterceptor API.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConnectedAddress() Retrieves the server address to which the client is connected, if available.
int	getConnectedPort() Retrieves the server port to which the client is connected, if available.
long	getConnectionID() Retrieves the connection ID for the associated client connection.
int	getMessageID() Retrieves the LDAP message ID for this operation.
java.lang.Object	getProperty(java.lang.String name) Retrieves the value for a property that has previously been set for this operation.
void	sendUnsolicitedNotification(ExtendedResult unsolicitedNotification) Sends an unsolicited notification message to the client.

Method Detail

getConnectionID

long getConnectionID()

Retrieves the connection ID for the associated client connection.

Returns:

The connection ID for the associated client connection.

getConnectedAddress

@Nullable
java.lang.String getConnectedAddress()

Retrieves the server address to which the client is connected, if available.

Returns:

The server address to which the client is connected, or null if this is not available for some reason.

getConnectedPort

int getConnectedPort()

Retrieves the server port to which the client is connected, if available.

Returns:

The server port to which the client is connected, or -1 if this is not available for some reason.

getMessageID

int getMessageID()

Retrieves the LDAP message ID for this operation.

Returns:

The LDAP message ID for this operation.

sendUnsolicitedNotification

void sendUnsolicitedNotification(@NotNull
                                 ExtendedResult unsolicitedNotification)
                          throws LDAPException

Sends an unsolicited notification message to the client.

Parameters:

unsolicitedNotification - The unsolicited notification to send to the client. It must not be null.

Throws:

LDAPException - If a problem is encountered while trying to send the unsolicited notification.

getProperty

@Nullable
java.lang.Object getProperty(@NotNull
                                       java.lang.String name)

Retrieves the value for a property that has previously been set for this operation. This can be used to help maintain state information across the request and response for an operation.

Parameters:

name - The name of the property for which to retrieve the corresponding value. It must not be null.

Returns:

The value for the requested property, or null if there is no value for the specified property.