|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.extensions.NoticeOfDisconnectionExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NoticeOfDisconnectionExtendedResult
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 the UnsolicitedNotificationHandler
interface for a mechanism that can be used to receive and handle unsolicited
notifications.
Field Summary | |
---|---|
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 | |
---|---|
NoticeOfDisconnectionExtendedResult(ExtendedResult extendedResult)
Creates a new instance of this notice of disconnection extended result from the provided generic extended result. |
|
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(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 | |
---|---|
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, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NOTICE_OF_DISCONNECTION_RESULT_OID
Constructor Detail |
---|
public NoticeOfDisconnectionExtendedResult(ResultCode resultCode, java.lang.String diagnosticMessage, Control... responseControls)
resultCode
- The result code for the notice of disconnection.diagnosticMessage
- The diagnostic message to include in the
notice of disconnection. It may be null
if no diagnostic message should be included.responseControls
- The set of controls to include in the notice of
disconnection. It may be null
or empty
if no response controls are needed.public NoticeOfDisconnectionExtendedResult(ExtendedResult extendedResult)
extendedResult
- The extended result to use to create this notice of
disconnection extended result.public NoticeOfDisconnectionExtendedResult(LDAPException ldapException)
ldapException
- The LDAP exception to use to create this notice of
disconnection extended result.public NoticeOfDisconnectionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, Control[] responseControls)
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 |
---|
public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended result will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |