Class AdministrativeOperationRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.AdministrativeOperationRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AdministrativeOperationRequestControl extends Control
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).
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
This request control has an OID of 1.3.6.1.4.1.30221.2.5.11 and a criticality of false. It may optionally have a value that is simply the bytes that comprise the message to include in the control.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
-
-
-
-
Field Detail
-
ADMINISTRATIVE_OPERATION_REQUEST_OID
public static final 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.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AdministrativeOperationRequestControl
public AdministrativeOperationRequestControl()
Creates a new administrative operation request control with no message.
-
AdministrativeOperationRequestControl
public AdministrativeOperationRequestControl(java.lang.String message)
Creates a new administrative operation request control with the provided informational message.- Parameters:
message
- A message with additional information about the purpose of the associated operation. It may benull
if no additional message should be provided.
-
AdministrativeOperationRequestControl
public AdministrativeOperationRequestControl(Control control)
Creates a new administrative operation request control decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as an administrative operation request control.
-
-
Method Detail
-
getMessage
public java.lang.String getMessage()
Retrieves the informational message for this control, if defined.- Returns:
- The informational message for this control, or
null
if none was provided.
-
getControlName
public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getControlName
in classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-