Package com.unboundid.ldap.sdk.extensions

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, 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 the UnsolicitedNotificationHandler 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 final 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, String diagnosticMessage, String matchedDN, 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, String diagnosticMessage, Control... responseControls)	Creates a new instance of this notice of disconnection extended result from the provided generic extended result.

Method Summary

Modifier and Type	Method	Description
String	getExtendedResultName()	Retrieves the user-friendly name for the extended result, if available.
void	toString(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NOTICE_OF_DISCONNECTION_RESULT_OID

@NotNull
public static final 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 Details

NoticeOfDisconnectionExtendedResult

public NoticeOfDisconnectionExtendedResult(@NotNull
 ResultCode resultCode,
 @Nullable
 String diagnosticMessage,
 @Nullable
 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 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.

NoticeOfDisconnectionExtendedResult

public NoticeOfDisconnectionExtendedResult(@NotNull
 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(@NotNull
 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,
 @NotNull
 ResultCode resultCode,
 @Nullable
 String diagnosticMessage,
 @Nullable
 String matchedDN,
 @Nullable
 String[] referralURLs,
 @Nullable
 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 Details

getExtendedResultName

@NotNull
public 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, then null will be returned.

Overrides:

getExtendedResultName in class ExtendedResult

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(@NotNull
 StringBuilder buffer)

Appends a string representation of this extended result to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class ExtendedResult

Parameters:

buffer - The buffer to which a string representation of this extended result will be appended.