|
|||||||||
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.OperationPurposeRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class OperationPurposeRequestControl
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 provides a request control that can be used by the client to identify the purpose of the associated operation. It can be used in conjunction with any kind of operation, and may be used to provide information about the reason for that operation, as well as about the client application used to generate the request. This may be very useful for debugging and auditing purposes.
true
or false
.
It must have a value with the following encoding:
OperationPurposeRequest ::= SEQUENCE { applicationName [0] OCTET STRING OPTIONAL, applicationVersion [1] OCTET STRING OPTIONAL, codeLocation [2] OCTET STRING OPTIONAL, requestPurpose [3] OCTET STRING OPTIONAL ... }At least one of the elements in the value sequence must be present.
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com", SearchScope.SUB, Filter.createEqualityFilter("uid", uidValue), "1.1"); searchRequest.addControl(new OperationPurposeRequestControl(appName, appVersion, 0, "Retrieve the entry for a user with a given uid")); Entry userEntry = connection.searchForEntry(searchRequest); SimpleBindRequest bindRequest = new SimpleBindRequest(userEntry.getDN(), password, new OperationPurposeRequestControl(appName, appVersion, 0, "Bind as a user to verify the provided credentials.")); BindResult bindResult = connection.bind(bindRequest);
Field Summary | |
---|---|
static java.lang.String |
OPERATION_PURPOSE_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.19) for the operation purpose request control. |
Constructor Summary | |
---|---|
OperationPurposeRequestControl(boolean isCritical,
java.lang.String applicationName,
java.lang.String applicationVersion,
java.lang.String codeLocation,
java.lang.String requestPurpose)
Creates a new operation purpose request control with the provided information. |
|
OperationPurposeRequestControl(Control control)
Creates a new operation purpose request control which is decoded from the provided generic control. |
|
OperationPurposeRequestControl(java.lang.String applicationName,
java.lang.String applicationVersion,
int codeLocationFrames,
java.lang.String requestPurpose)
Creates a new operation purpose request control with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getApplicationName()
Retrieves the name of the application that generated the associated request, if available. |
java.lang.String |
getApplicationVersion()
Retrieves information about the version of the application that generated the associated request, if available. |
java.lang.String |
getCodeLocation()
Retrieves information about the location in the application code in which the associated request was created, if available. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
java.lang.String |
getRequestPurpose()
Retrieves a message with information about the purpose of the associated request, if available. |
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 OPERATION_PURPOSE_REQUEST_OID
Constructor Detail |
---|
public OperationPurposeRequestControl(java.lang.String applicationName, java.lang.String applicationVersion, int codeLocationFrames, java.lang.String requestPurpose)
false
, then at least one of the
applicationName, applicationVersion, and requestPurpose arguments must
be non-null
.
applicationName
- The name of the application generating the
associated request. It may be null
if
this should not be included in the control.applicationVersion
- Information about the version of the
application generating the associated request.
It may be null
if this should not be
included in the control.codeLocationFrames
- Indicates that the code location should be
automatically generated with a condensed stack
trace for the current thread, using the
specified number of stack frames. A value that
is less than or equal to zero indicates an
unlimited number of stack frames should be
included.requestPurpose
- A string identifying the purpose of the
associated request. It may be null
if
this should not be included in the control.public OperationPurposeRequestControl(boolean isCritical, java.lang.String applicationName, java.lang.String applicationVersion, java.lang.String codeLocation, java.lang.String requestPurpose)
null
.
isCritical
- Indicates whether the control should be
considered critical.applicationName
- The name of the application generating the
associated request. It may be null
if
this should not be included in the control.applicationVersion
- Information about the version of the
application generating the associated request.
It may be null
if this should not be
included in the control.codeLocation
- Information about the location in the
application code in which the associated
request is generated (e.g., the class and/or
method name, or any other useful identifier).
It may be null
if this should not be
included in the control.requestPurpose
- A string identifying the purpose of the
associated request. It may be null
if
this should not be included in the control.public OperationPurposeRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as an operation purpose
request control.
LDAPException
- If the provided control cannot be decoded as an
operation purpose request control.Method Detail |
---|
public java.lang.String getApplicationName()
null
if that is not available.public java.lang.String getApplicationVersion()
null
if that is not available.public java.lang.String getCodeLocation()
null
if that is not
available.public java.lang.String getRequestPurpose()
null
if that is not available.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 |