|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.IntermediateClientRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IntermediateClientRequestControl
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class defines an intermediate client request control, which can be used to provide a server with information about the client and any downstream clients that it may have. It can be used to help trace operations from the client to the directory server, potentially through any intermediate hops (like proxy servers) that may also support the intermediate client controls.
IntermediateClientRequest ::= SEQUENCE { downstreamRequest [0] IntermediateClientRequest OPTIONAL, downstreamClientAddress [1] OCTET STRING OPTIONAL, downstreamClientSecure [2] BOOLEAN DEFAULT FALSE, clientIdentity [3] authzId OPTIONAL, clientName [4] OCTET STRING OPTIONAL, clientSessionID [5] OCTET STRING OPTIONAL, clientRequestID [6] OCTET STRING OPTIONAL, ... }
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com", SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe")); searchRequest.addControl(new IntermediateClientRequestControl(null, null, null, null, "my client", "session123", "request456")); SearchResult searchResult = connection.search(searchRequest); IntermediateClientResponseControl c = IntermediateClientResponseControl.get(searchResult); if (c != null) { // There was an intermediate client response control. IntermediateClientResponseValue responseValue = c.getResponseValue(); }
Field Summary | |
---|---|
static java.lang.String |
INTERMEDIATE_CLIENT_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.2) for the intermediate client request control. |
Constructor Summary | |
---|---|
IntermediateClientRequestControl(boolean isCritical,
IntermediateClientRequestValue value)
Creates a new intermediate client request control with the provided value. |
|
IntermediateClientRequestControl(Control control)
Creates a new intermediate client request control which is decoded from the provided generic control. |
|
IntermediateClientRequestControl(IntermediateClientRequestValue value)
Creates a new intermediate client request control with the provided value. |
|
IntermediateClientRequestControl(IntermediateClientRequestValue downstreamRequest,
java.lang.String downstreamClientAddress,
java.lang.Boolean downstreamClientSecure,
java.lang.String clientIdentity,
java.lang.String clientName,
java.lang.String clientSessionID,
java.lang.String clientRequestID)
Creates a new intermediate client request control with the provided information. |
Method Summary | |
---|---|
java.lang.Boolean |
downstreamClientSecure()
Indicates whether the communication with the communication with the downstream client is secure (i.e., whether communication between the client application and the downstream client is safe from interpretation or undetectable alteration by a third party observer or interceptor). |
java.lang.String |
getClientIdentity()
Retrieves the requested client authorization identity, if available. |
java.lang.String |
getClientName()
Retrieves a string that identifies the client application that created this intermediate client request value. |
java.lang.String |
getClientRequestID()
Retrieves a string that may be used to identify the request in the client application. |
java.lang.String |
getClientSessionID()
Retrieves a string that may be used to identify the session in the client application. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
java.lang.String |
getDownstreamClientAddress()
Retrieves the IP address or resolvable name of the downstream client system, if available. |
IntermediateClientRequestValue |
getDownstreamRequest()
Retrieves the wrapped request from a downstream client, if available. |
IntermediateClientRequestValue |
getRequestValue()
Retrieves the value for this intermediate client request. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.Control |
---|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String INTERMEDIATE_CLIENT_REQUEST_OID
Constructor Detail |
---|
public IntermediateClientRequestControl(IntermediateClientRequestValue downstreamRequest, java.lang.String downstreamClientAddress, java.lang.Boolean downstreamClientSecure, java.lang.String clientIdentity, java.lang.String clientName, java.lang.String clientSessionID, java.lang.String clientRequestID)
downstreamRequest
- A wrapped intermediate client request from
a downstream client. It may be
null
if there is no downstream
request.downstreamClientAddress
- The IP address or resolvable name of the
downstream client system. It may be
null
if there is no downstream
client or its address is not available.downstreamClientSecure
- Indicates whether communication with the
downstream client is secure. It may be
null
if there is no downstream
client or it is not known whether the
communication is secure.clientIdentity
- The requested client authorization
identity. It may be null
if there
is no requested authorization identity.clientName
- An identifier string that summarizes the
client application that created this
intermediate client request. It may be
null
if that information is not
available.clientSessionID
- A string that may be used to identify the
session in the client application. It may
be null
if there is no available
session identifier.clientRequestID
- A string that may be used to identify the
request in the client application. It may
be null
if there is no available
request identifier.public IntermediateClientRequestControl(IntermediateClientRequestValue value)
value
- The value to use for this intermediate client request
control. It must not be null
.public IntermediateClientRequestControl(boolean isCritical, IntermediateClientRequestValue value)
isCritical
- Indicates whether the control should be marked
critical.value
- The value to use for this intermediate client request
control. It must not be null
.public IntermediateClientRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as an intermediate
client request control.
LDAPException
- If the provided control cannot be decoded as an
intermediate client request control.Method Detail |
---|
public IntermediateClientRequestValue getRequestValue()
public IntermediateClientRequestValue getDownstreamRequest()
null
if
there is none.public java.lang.String getClientIdentity()
null
if
there is none.public java.lang.String getDownstreamClientAddress()
null
if there is no downstream client or its address is
not available.public java.lang.Boolean downstreamClientSecure()
Boolean.TRUE
if communication with the downstream client
is secure, Boolean.FALSE
if it is not secure, or
null
if there is no downstream client or it is not known
whether the communication is secure.public java.lang.String getClientName()
public java.lang.String getClientSessionID()
null
if there is none.public java.lang.String getClientRequestID()
null
if there is none.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |