|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ReadOnlyLDAPRequest
This interface defines a set of methods that may be safely called in an LDAP
request without altering its contents. This interface must not be
implemented by any class outside of the LDAP SDK.
This interface does not inherently provide the assurance of thread safety for
the methods that it exposes, because it is still possible for a thread
referencing the object which implements this interface to alter the request
using methods not included in this interface. However, if it can be
guaranteed that no thread will alter the underlying object, then the methods
exposed by this interface can be safely invoked concurrently by any number of
threads.
Method Summary | |
---|---|
LDAPRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
LDAPRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
boolean |
followReferrals(LDAPConnection connection)
Indicates whether to automatically follow any referrals encountered while processing this request. |
Control |
getControl(java.lang.String oid)
Retrieves the control with the specified OID from this request. |
java.util.List<Control> |
getControlList()
Retrieves a list containing the set of controls for this request. |
long |
getResponseTimeoutMillis(LDAPConnection connection)
Retrieves the maximum length of time in milliseconds that processing on this operation should be allowed to block while waiting for a response from the server. |
boolean |
hasControl()
Indicates whether this request contains at least one control. |
boolean |
hasControl(java.lang.String oid)
Indicates whether this request contains at least one control with the specified OID. |
void |
toCode(java.util.List<java.lang.String> lineList,
java.lang.String requestID,
int indentSpaces,
boolean includeProcessing)
Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list. |
java.lang.String |
toString()
Retrieves a string representation of this request. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer. |
Method Detail |
---|
java.util.List<Control> getControlList()
boolean hasControl()
true
if this request contains at least one control, or
false
if not.boolean hasControl(java.lang.String oid)
oid
- The object identifier for which to make the determination. It
must not be null
.
true
if this request contains at least one control with
the specified OID, or false
if not.Control getControl(java.lang.String oid)
oid
- The object identifier for which to retrieve the corresponding
control. It must not be null
.
null
if
no control with that OID is included in this request.long getResponseTimeoutMillis(LDAPConnection connection)
connection
- The connection to use in order to retrieve the default
value, if appropriate. It may be null
to
retrieve the request-specific timeout (which may be
negative if no response-specific timeout has been set).
boolean followReferrals(LDAPConnection connection)
connection
- The connection whose connection options may be used in
the course of making the determination. It must not
be null
.
true
if any referrals encountered during processing should
be automatically followed, or false
if not.LDAPRequest duplicate()
LDAPRequest duplicate(Control[] controls)
controls
- The set of controls to include in the duplicate request.
java.lang.String toString()
toString
in class java.lang.Object
void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which to append a string representation of
this request.void toCode(java.util.List<java.lang.String> lineList, java.lang.String requestID, int indentSpaces, boolean includeProcessing)
lineList
- The list to which the source code lines should
be added.requestID
- The name that should be used as an identifier
for the request. If this is null
or
empty, then a generic ID will be used.indentSpaces
- The number of spaces that should be used to
indent the generated code. It must not be
negative.includeProcessing
- Indicates whether the generated code should
include code required to actually process the
request and handle the result (if true
),
or just to generate the request (if
false
).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |