Package com.unboundid.ldap.sdk.unboundidds.extensions

Class ListNotificationSubscriptionsExtendedRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.ListNotificationSubscriptionsExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListNotificationSubscriptionsExtendedRequest extends ExtendedRequest
This class provides an extended request that may be used to retrieve a list of the subscriptions associated with a specified notification manager, optionally restricted to a specified set of destinations.
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 request has an OID of 1.3.6.1.4.1.30221.2.6.40 and a value with the following encoding: 

   ListNotificationSubscriptionsRequest ::= SEQUENCE {
        notificationManagerID          OCTET STRING,
        notificationDestinationIDs     SET OF OCTET STRING OPTIONAL }
See Also:

  • Field Details

  • Constructor Details

    • ListNotificationSubscriptionsExtendedRequest

      public ListNotificationSubscriptionsExtendedRequest(@NotNull String managerID, @Nullable String... destinationIDs)
      Creates a new list notification subscriptions extended request with the provided information.
      Parameters:
      managerID - The notification manager ID. It must not be null.
      destinationIDs - The set of notification destination IDs for which to retrieve the subscription information. It may be null or empty if subscription information for all destinations should be returned.

    • ListNotificationSubscriptionsExtendedRequest

      public ListNotificationSubscriptionsExtendedRequest(@NotNull String managerID, @Nullable Collection<String> destinationIDs, @Nullable Control... controls)
      Creates a new list notification subscriptions extended request with the provided information.
      Parameters:
      managerID - The notification manager ID. It must not be null.
      destinationIDs - The set of notification destination IDs for which to retrieve the subscription information. It may be null or empty if subscription information for all destinations should be returned.
      controls - The set of controls to include in the request. It may be null or empty if no controls are needed.

    • ListNotificationSubscriptionsExtendedRequest

      public ListNotificationSubscriptionsExtendedRequest(@NotNull ExtendedRequest extendedRequest) throws LDAPException
      Creates a new list notification subscriptions extended request from the provided generic extended request.
      Parameters:
      extendedRequest - The generic extended request to use to create this list notification subscriptions extended request.
      Throws:
      LDAPException - If a problem occurs while decoding the request.

  • Method Details

    • process

      @NotNull public ListNotificationSubscriptionsExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
      Sends this extended request to the directory server over the provided connection and returns the associated response.
      Overrides:
      process in class ExtendedRequest
      Parameters:
      connection - The connection to use to communicate with the directory server.
      depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
      Returns:
      An LDAP result object that provides information about the result of the extended operation processing.
      Throws:
      LDAPException - If a problem occurs while sending the request or reading the response.

    • getManagerID

      @NotNull public String getManagerID()
      Retrieves the notification manager ID.
      Returns:
      The notification manager ID.

    • getDestinationIDs

      @NotNull public Set<String> getDestinationIDs()
      Retrieves the notification destination IDs, if any were provided.
      Returns:
      The notification destination IDs, or an empty set if none were provided.

    • duplicate

      @NotNull public ListNotificationSubscriptionsExtendedRequest 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

      @NotNull public ListNotificationSubscriptionsExtendedRequest duplicate(@Nullable 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

      @NotNull public 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(@NotNull 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.