Class ListNotificationSubscriptionsExtendedResult
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPResult
-
- com.unboundid.ldap.sdk.ExtendedResult
-
- com.unboundid.ldap.sdk.unboundidds.extensions.ListNotificationSubscriptionsExtendedResult
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListNotificationSubscriptionsExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that can be used to provide information about the notification subscriptions defined in the target server.
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.
The OID for this result is 1.3.6.1.4.1.30221.2.6.41, and the value (if present) should have the following encoding:
ListNotificationSubscriptionsResponse ::= SEQUENCE OF SEQUENCE { notificationDestinationID OCTET STRING, destinationDetails SEQUENCE OF OCTET STRING, subscriptions SEQUENCE OF SEQUENCE { subscriptionID OCTET STRING, subscriptionDetails SEQUENCE OF OCTET STRING } }
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
LIST_NOTIFICATION_SUBSCRIPTIONS_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.41) for the list notification subscriptions extended result.-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description ListNotificationSubscriptionsExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.util.Collection<NotificationDestinationDetails> destinations, Control... controls)
Creates a new list notification subscriptions extended request with the provided information.ListNotificationSubscriptionsExtendedResult(ExtendedResult extendedResult)
Creates a new list notification subscriptions extended result from the provided extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<NotificationDestinationDetails>
getDestinations()
Retrieves a list of the defined notification destinations and their associated subscriptions.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
-
-
-
-
Field Detail
-
LIST_NOTIFICATION_SUBSCRIPTIONS_RESULT_OID
public static final java.lang.String LIST_NOTIFICATION_SUBSCRIPTIONS_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.41) for the list notification subscriptions extended result.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ListNotificationSubscriptionsExtendedResult
public ListNotificationSubscriptionsExtendedResult(ExtendedResult extendedResult) throws LDAPException
Creates a new list notification subscriptions extended result from the provided extended result.- Parameters:
extendedResult
- The extended result to be decoded as a list notification subscriptions extended result.- Throws:
LDAPException
- If a problem is encountered while attempting to decode the provided extended result as a multi-update result.
-
ListNotificationSubscriptionsExtendedResult
public ListNotificationSubscriptionsExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.util.Collection<NotificationDestinationDetails> destinations, Control... controls) throws LDAPException
Creates a new list notification subscriptions extended request with the provided information.- Parameters:
messageID
- The message ID for this extended result.resultCode
- The result code for this result. It must not benull
.diagnosticMessage
- The diagnostic message to include in the result. It may benull
if no diagnostic message should be included.matchedDN
- The matched DN to include in the result. It may benull
if no matched DN should be included.referralURLs
- The set of referral URLs to include in the result. It may benull
or empty if no referral URLs should be included.destinations
- The notification destination details for this result. It may benull
or empty for a non-success result.controls
- The set of controls to include in the multi-update result. It may benull
or empty if no controls should be included.- Throws:
LDAPException
- If any of the results are for an inappropriate operation type.
-
-
Method Detail
-
getDestinations
public java.util.List<NotificationDestinationDetails> getDestinations()
Retrieves a list of the defined notification destinations and their associated subscriptions.- Returns:
- A list of the defined notification destinations and their associated subscriptions.
-
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.
-
-