Class SetNotificationDestinationExtendedRequest

  • All Implemented Interfaces:
    ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class SetNotificationDestinationExtendedRequest
    extends ExtendedRequest
    This class provides an extended request that may be used to create or update a notification destination.
    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.36 and a value with the following encoding:

       SetNotificationDestinationRequest ::= SEQUENCE {
            notificationManagerID         OCTET STRING,
            notificationDestinationID     OCTET STRING,
            destinationDetails            SEQUENCE OF OCTET STRING,
            changeType                    [0] ENUMERATED {
                 replace (0),
                 add (1),
                 delete (2) } DEFAULT replace }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • SetNotificationDestinationExtendedRequest

        public SetNotificationDestinationExtendedRequest​(java.lang.String managerID,
                                                         java.lang.String destinationID,
                                                         ASN1OctetString... destinationDetails)
        Creates a new set notification destination extended request with the provided information.
        Parameters:
        managerID - The notification manager ID. It must not be null.
        destinationID - The notification destination ID. It must not be null.
        destinationDetails - The implementation-specific details for the notification destination. At least one detail value must be provided.
      • SetNotificationDestinationExtendedRequest

        public SetNotificationDestinationExtendedRequest​(java.lang.String managerID,
                                                         java.lang.String destinationID,
                                                         java.util.Collection<ASN1OctetString> destinationDetails,
                                                         Control... controls)
        Creates a new set notification destination extended request with the provided information.
        Parameters:
        managerID - The notification manager ID. It must not be null.
        destinationID - The notification destination ID. It must not be null.
        destinationDetails - The implementation-specific details for the notification destination. At least one detail value must be provided.
        controls - The set of controls to include in the request. It may be null or empty if no controls are needed.
      • SetNotificationDestinationExtendedRequest

        public SetNotificationDestinationExtendedRequest​(java.lang.String managerID,
                                                         java.lang.String destinationID,
                                                         java.util.Collection<ASN1OctetString> destinationDetails,
                                                         SetNotificationDestinationChangeType changeType,
                                                         Control... controls)
        Creates a new set notification destination extended request with the provided information.
        Parameters:
        managerID - The notification manager ID. It must not be null.
        destinationID - The notification destination ID. It must not be null.
        destinationDetails - The implementation-specific details for the notification destination. At least one detail value must be provided.
        changeType - The change type for the destination details.
        controls - The set of controls to include in the request. It may be null or empty if no controls are needed.
      • SetNotificationDestinationExtendedRequest

        public SetNotificationDestinationExtendedRequest​(ExtendedRequest extendedRequest)
                                                  throws LDAPException
        Creates a new set notification destination extended request from the provided generic extended request.
        Parameters:
        extendedRequest - The generic extended request to use to create this set notification destination extended request.
        Throws:
        LDAPException - If a problem occurs while decoding the request.
    • Method Detail

      • getManagerID

        public java.lang.String getManagerID()
        Retrieves the notification manager ID.
        Returns:
        The notification manager ID.
      • getDestinationID

        public java.lang.String getDestinationID()
        Retrieves the notification destination ID.
        Returns:
        The notification destination ID.
      • getDestinationDetails

        public java.util.List<ASN1OctetStringgetDestinationDetails()
        Retrieves the implementation-specific details for the notification destination.
        Returns:
        The implementation-specific details for the notification destination.
      • duplicate

        public SetNotificationDestinationExtendedRequest duplicate​(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

        public java.lang.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​(java.lang.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.