|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface InMemoryInterceptedRequest
This class provides an API that can be used in the course of processing a
request via the InMemoryOperationInterceptor
API.
Method Summary | |
---|---|
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 |
sendIntermediateResponse(IntermediateResponse intermediateResponse)
Sends the provided intermediate response message to the client. |
void |
sendUnsolicitedNotification(ExtendedResult unsolicitedNotification)
Sends an unsolicited notification message to the client. |
java.lang.Object |
setProperty(java.lang.String name,
java.lang.Object value)
Sets the value for a property that may be used to help maintain state information across the request and response for an operation. |
Method Detail |
---|
long getConnectionID()
java.lang.String getConnectedAddress()
null
if this is not available for some reason.int getConnectedPort()
int getMessageID()
void sendIntermediateResponse(IntermediateResponse intermediateResponse) throws LDAPException
InMemoryOperationInterceptor.processIntermediateResponse(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedIntermediateResponse)
method of
all registered operation interceptors.
intermediateResponse
- The intermediate response to send to the
client. It must not be null
.
LDAPException
- If a problem is encountered while trying to send
the intermediate response.void sendUnsolicitedNotification(ExtendedResult unsolicitedNotification) throws LDAPException
unsolicitedNotification
- The unsolicited notification to send to
the client. It must not be null
.
LDAPException
- If a problem is encountered while trying to send
the unsolicited notification.java.lang.Object getProperty(java.lang.String name)
name
- The name of the property for which to retrieve the
corresponding value. It must not be null
.
null
if there is
no value for the specified property.java.lang.Object setProperty(java.lang.String name, java.lang.Object value)
name
- The name of the property to set. It must not be
null
.value
- The value to use for the property. If it is null
,
then any value previously set will be removed.
null
if it did not previously have a value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |