|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.controls.IntermediateClientRequestValue
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IntermediateClientRequestValue
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 implements a data structure which encapsulates the value of an intermediate client request value. It may recursively embed intermediate client request values from downstream clients.
IntermediateClientRequestControl
class
for an example of using the intermediate client request and response
controls.
Constructor Summary | |
---|---|
IntermediateClientRequestValue(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 value with the provided information. |
Method Summary | |
---|---|
static IntermediateClientRequestValue |
decode(ASN1Sequence sequence)
Decodes the provided ASN.1 sequence as an intermediate client request value. |
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). |
ASN1Sequence |
encode()
Encodes this intermediate client request value to a form that may be included in the request control. |
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this intermediate client request value. |
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 |
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. |
int |
hashCode()
Generates a hash code for this intermediate client request value. |
java.lang.String |
toString()
Retrieves a string representation of this intermediate client request value. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate client request value to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public IntermediateClientRequestValue(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.Method Detail |
---|
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 ASN1Sequence encode()
public static IntermediateClientRequestValue decode(ASN1Sequence sequence) throws LDAPException
sequence
- The sequence to be decoded as an intermediate client
request value.
LDAPException
- If the provided sequence cannot be decoded as an
intermediate client request value.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is considered equal to this
intermediate client request value, or false
if not.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information is to be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |