com.unboundid.ldap.sdk.unboundidds.extensions
Class EndAdministrativeSessionExtendedRequest

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.ExtendedRequest
          extended by 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

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 the end administrative session extended request, which indicates that an administrative session created via with the StartAdministrativeSessionExtendedRequest should be ended.

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 the StartAdministrativeSessionExtendedRequest for more information about creating and using administrative sessions.

See Also:
Serialized Form

Field Summary
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
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
 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, writeTo
 
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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 interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
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 interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
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 class ExtendedRequest
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 interface ProtocolOp
Specified by:
toString in interface ReadOnlyLDAPRequest
Overrides:
toString in class ExtendedRequest
Parameters:
buffer - The buffer to which to append a string representation of this request.