Class NoticeOfDisconnectionExtendedResult
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPResult
-
- com.unboundid.ldap.sdk.ExtendedResult
-
- com.unboundid.ldap.sdk.extensions.NoticeOfDisconnectionExtendedResult
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NoticeOfDisconnectionExtendedResult extends ExtendedResult
This class provides an implementation of the notice of disconnection extended result as defined in RFC 4511. It may be used as an unsolicited notification to indicate that the directory server is closing the client connection.
See theUnsolicitedNotificationHandler
interface for a mechanism that can be used to receive and handle unsolicited notifications.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NOTICE_OF_DISCONNECTION_RESULT_OID
The OID (1.3.6.1.4.1.1466.20036) for the notice of disconnection extended result.-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description NoticeOfDisconnectionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, Control[] responseControls)
Creates a new instance of this notice of disconnection extended result from the provided information.NoticeOfDisconnectionExtendedResult(ExtendedResult extendedResult)
Creates a new instance of this notice of disconnection extended result from the provided generic extended result.NoticeOfDisconnectionExtendedResult(LDAPException ldapException)
Creates a new instance of this notice of disconnection extended result from the provided LDAP exception.NoticeOfDisconnectionExtendedResult(ResultCode resultCode, java.lang.String diagnosticMessage, Control... responseControls)
Creates a new instance of this notice of disconnection extended result from the provided generic extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult
getOID, getValue, hasValue, toString
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult
getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl
-
-
-
-
Field Detail
-
NOTICE_OF_DISCONNECTION_RESULT_OID
public static final java.lang.String NOTICE_OF_DISCONNECTION_RESULT_OID
The OID (1.3.6.1.4.1.1466.20036) for the notice of disconnection extended result.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NoticeOfDisconnectionExtendedResult
public NoticeOfDisconnectionExtendedResult(ResultCode resultCode, java.lang.String diagnosticMessage, Control... responseControls)
Creates a new instance of this notice of disconnection extended result from the provided generic extended result.- Parameters:
resultCode
- The result code for the notice of disconnection.diagnosticMessage
- The diagnostic message to include in the notice of disconnection. It may benull
if no diagnostic message should be included.responseControls
- The set of controls to include in the notice of disconnection. It may benull
or empty if no response controls are needed.
-
NoticeOfDisconnectionExtendedResult
public NoticeOfDisconnectionExtendedResult(ExtendedResult extendedResult)
Creates a new instance of this notice of disconnection extended result from the provided generic extended result.- Parameters:
extendedResult
- The extended result to use to create this notice of disconnection extended result.
-
NoticeOfDisconnectionExtendedResult
public NoticeOfDisconnectionExtendedResult(LDAPException ldapException)
Creates a new instance of this notice of disconnection extended result from the provided LDAP exception.- Parameters:
ldapException
- The LDAP exception to use to create this notice of disconnection extended result.
-
NoticeOfDisconnectionExtendedResult
public NoticeOfDisconnectionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, Control[] responseControls)
Creates a new instance of this notice of disconnection extended result from the provided information.- Parameters:
messageID
- The message ID for the LDAP message that is associated with this LDAP result.resultCode
- The result code from the response.diagnosticMessage
- The diagnostic message from the response, if available.matchedDN
- The matched DN from the response, if available.referralURLs
- The set of referral URLs from the response, if available.responseControls
- The set of controls from the response, if available.
-
-
Method Detail
-
getExtendedResultName
public java.lang.String getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, thennull
will be returned.- Overrides:
getExtendedResultName
in classExtendedResult
- Returns:
- The user-friendly name for this extended request, the response OID
if a user-friendly name is not available but a response OID is, or
null
if neither a user-friendly name nor a response OID are available.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classExtendedResult
- Parameters:
buffer
- The buffer to which a string representation of this extended result will be appended.
-
-