|
|||||||||
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.AdministrativeOperationRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AdministrativeOperationRequestControl
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 an implementation of a Directory Server control that may be used to indicate that the associated operation is used for performing some administrative operation within the server rather than one that was requested by a "normal" client. The server can use this indication to treat the operation differently (e.g., exclude it from the processing time histogram, or to include additional information about the purpose of the operation in the access log).
Field Summary | |
---|---|
static java.lang.String |
ADMINISTRATIVE_OPERATION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.11) for the administrative operation request control. |
Constructor Summary | |
---|---|
AdministrativeOperationRequestControl()
Creates a new administrative operation request control with no message. |
|
AdministrativeOperationRequestControl(Control control)
Creates a new administrative operation request control decoded from the provided generic control. |
|
AdministrativeOperationRequestControl(java.lang.String message)
Creates a new administrative operation request control with the provided informational message. |
Method Summary | |
---|---|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
java.lang.String |
getMessage()
Retrieves the informational message for this control, if defined. |
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 ADMINISTRATIVE_OPERATION_REQUEST_OID
Constructor Detail |
---|
public AdministrativeOperationRequestControl()
public AdministrativeOperationRequestControl(java.lang.String message)
message
- A message with additional information about the purpose of
the associated operation. It may be null
if no
additional message should be provided.public AdministrativeOperationRequestControl(Control control)
control
- The generic control to be decoded as an administrative
operation request control.Method Detail |
---|
public java.lang.String getMessage()
null
if
none was provided.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 |