Class JSONOperationPurposeRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONOperationPurposeRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONOperationPurposeRequestControl extends java.lang.Object implements java.io.Serializable
This class provides a data structure that contains information about an JSON-formatted operation purpose request control.
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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description JSONOperationPurposeRequestControl(JSONObject controlObject)
Creates a new JSON operation purpose request control that is decoded from the provided JSON object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getApplicationName()
Retrieves the name of the application that generated this control.java.lang.String
getApplicationVersion()
Retrieves the version of the application that generated this control.java.lang.String
getCodeLocation()
Retrieves a description of the location in the application code where the control was generated.JSONObject
getControlObject()
Retrieves a JSON object containing an encoded representation of this operation purpose request control.java.lang.String
getRequestPurpose()
Retrieves the request purpose from the control.java.lang.String
toString()
Retrieves a string representation of this operation purpose request control.
-
-
-
Constructor Detail
-
JSONOperationPurposeRequestControl
public JSONOperationPurposeRequestControl(@NotNull JSONObject controlObject)
Creates a new JSON operation purpose request control that is decoded from the provided JSON object.- Parameters:
controlObject
- The JSON object containing an encoded representation of this operation purpose request control.
-
-
Method Detail
-
getControlObject
@NotNull public JSONObject getControlObject()
Retrieves a JSON object containing an encoded representation of this operation purpose request control.- Returns:
- A JSON object containing an encoded representation of this operation purpose request control.
-
getApplicationName
@Nullable public java.lang.String getApplicationName()
Retrieves the name of the application that generated this control.- Returns:
- The name of the application that generated this control, or
null
if it was not included in the log message.
-
getApplicationVersion
@Nullable public java.lang.String getApplicationVersion()
Retrieves the version of the application that generated this control.- Returns:
- The version of the application that generated this control, or
null
if it was not included in the log message.
-
getCodeLocation
@Nullable public java.lang.String getCodeLocation()
Retrieves a description of the location in the application code where the control was generated.- Returns:
- A description of the location in the application code where the
control was generated, or
null
if it was not included in the log message.
-
getRequestPurpose
@Nullable public java.lang.String getRequestPurpose()
Retrieves the request purpose from the control.- Returns:
- The request purpose from the control, or
null
if it was not included in the log message.
-
-