Class EndAdministrativeSessionExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.unboundidds.extensions.EndAdministrativeSessionExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class EndAdministrativeSessionExtendedRequest extends ExtendedRequest
This class provides an implementation of the end administrative session extended request, which indicates that an administrative session created via with theStartAdministrativeSessionExtendedRequest
should be ended.
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 extended request has an OID of 1.3.6.1.4.1.30221.2.6.14, and it does not take a value.
See the documentation for theStartAdministrativeSessionExtendedRequest
for more information about creating and using administrative sessions.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
END_ADMIN_SESSION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.14) for the end administrative session extended request.-
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
-
-
Constructor Summary
Constructors Constructor Description EndAdministrativeSessionExtendedRequest(Control... controls)
Creates a new end administrative session extended request with the provided information.EndAdministrativeSessionExtendedRequest(ExtendedRequest extendedRequest)
Creates a new end administrative session extended request from the provided generic extended request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EndAdministrativeSessionExtendedRequest
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.EndAdministrativeSessionExtendedRequest
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request.java.lang.String
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, process, responseReceived, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
END_ADMIN_SESSION_REQUEST_OID
public static final java.lang.String END_ADMIN_SESSION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.14) for the end administrative session extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EndAdministrativeSessionExtendedRequest
public EndAdministrativeSessionExtendedRequest(Control... controls)
Creates a new end administrative session extended request with the provided information.- Parameters:
controls
- The set of controls to include in the request.
-
EndAdministrativeSessionExtendedRequest
public EndAdministrativeSessionExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
Creates a new end administrative session extended request from the provided generic extended request.- Parameters:
extendedRequest
- The generic extended request to use to create this end administrative session extended request.- Throws:
LDAPException
- If a problem occurs while decoding the request.
-
-
Method Detail
-
duplicate
public EndAdministrativeSessionExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
public EndAdministrativeSessionExtendedRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
getExtendedRequestName
public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getExtendedRequestName
in classExtendedRequest
- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-