com.unboundid.ldap.sdk.unboundidds.extensions

Class SetNotificationSubscriptionExtendedRequest

java.lang.Object

com.unboundid.ldap.sdk.LDAPRequest

com.unboundid.ldap.sdk.ExtendedRequest

com.unboundid.ldap.sdk.unboundidds.extensions.SetNotificationSubscriptionExtendedRequest

All Implemented Interfaces:

ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SetNotificationSubscriptionExtendedRequest
extends ExtendedRequest

This class provides an extended request that may be used to create or update a notification subscription.

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.38 and a value with the following encoding:

   SetNotificationSubscriptionRequest ::= SEQUENCE {
        notificationManagerID          OCTET STRING,
        notificationDestinationID      OCTET STRING,
        notificationSubscriptionID     OCTET STRING,
        subscriptionDetails            SEQUENCE OF OCTET STRING }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SET_NOTIFICATION_SUBSCRIPTION_REQUEST_OID The OID (1.3.6.1.4.1.30221.2.6.38) for the set notification subscription extended request.

Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest

TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE

Constructor Summary

Constructors

Constructor and Description
SetNotificationSubscriptionExtendedRequest(ExtendedRequest extendedRequest) Creates a new set notification subscription extended request from the provided generic extended request.
SetNotificationSubscriptionExtendedRequest(java.lang.String managerID, java.lang.String destinationID, java.lang.String subscriptionID, ASN1OctetString... subscriptionDetails) Creates a new set notification subscription extended request with the provided information.
SetNotificationSubscriptionExtendedRequest(java.lang.String managerID, java.lang.String destinationID, java.lang.String subscriptionID, java.util.Collection<ASN1OctetString> subscriptionDetails, Control... controls) Creates a new set notification subscription extended request with the provided information.

Method Summary

Modifier and Type	Method and Description
SetNotificationSubscriptionExtendedRequest	duplicate() Creates a new instance of this LDAP request that may be modified without impacting this request.
SetNotificationSubscriptionExtendedRequest	duplicate(Control[] controls) Creates a new instance of this LDAP request that may be modified without impacting this request.
java.lang.String	getDestinationID() Retrieves the notification destination ID.
java.lang.String	getExtendedRequestName() Retrieves the user-friendly name for the extended request, if available.
java.lang.String	getManagerID() Retrieves the notification manager ID.
java.util.List<ASN1OctetString>	getSubscriptionDetails() Retrieves the implementation-specific details for the notification subscription.
java.lang.String	getSubscriptionID() Retrieves the notification subscription ID.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this request to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest

encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, process, responseReceived, toCode, writeTo

Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest

followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString

Methods inherited from class java.lang.Object

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

Field Detail

SET_NOTIFICATION_SUBSCRIPTION_REQUEST_OID

@NotNull
public static final java.lang.String SET_NOTIFICATION_SUBSCRIPTION_REQUEST_OID

The OID (1.3.6.1.4.1.30221.2.6.38) for the set notification subscription extended request.

See Also:

Constant Field Values

Constructor Detail

SetNotificationSubscriptionExtendedRequest

public SetNotificationSubscriptionExtendedRequest(@NotNull
                                                  java.lang.String managerID,
                                                  @NotNull
                                                  java.lang.String destinationID,
                                                  @NotNull
                                                  java.lang.String subscriptionID,
                                                  @Nullable
                                                  ASN1OctetString... subscriptionDetails)

Creates a new set notification subscription 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.

subscriptionID - The notification subscription ID. It must not be null.

subscriptionDetails - The implementation-specific details for the notification subscription. At least one detail value must be provided.

SetNotificationSubscriptionExtendedRequest

public SetNotificationSubscriptionExtendedRequest(@NotNull
                                                  java.lang.String managerID,
                                                  @NotNull
                                                  java.lang.String destinationID,
                                                  @NotNull
                                                  java.lang.String subscriptionID,
                                                  @NotNull
                                                  java.util.Collection<ASN1OctetString> subscriptionDetails,
                                                  @Nullable
                                                  Control... controls)

Creates a new set notification subscription extended request with the provided information. Creates a new set notification subscription 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.

subscriptionID - The notification subscription ID. It must not be null.

subscriptionDetails - The implementation-specific details for the notification subscription. 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.

SetNotificationSubscriptionExtendedRequest

public SetNotificationSubscriptionExtendedRequest(@NotNull
                                                  ExtendedRequest extendedRequest)
                                           throws LDAPException

Creates a new set notification subscription extended request from the provided generic extended request.

Parameters:

extendedRequest - The generic extended request to use to create this set notification subscription extended request.

Throws:

LDAPException - If a problem occurs while decoding the request.

Method Detail

getManagerID

@NotNull
public java.lang.String getManagerID()

Retrieves the notification manager ID.

Returns:

The notification manager ID.

getDestinationID

@NotNull
public java.lang.String getDestinationID()

Retrieves the notification destination ID.

Returns:

The notification destination ID.

getSubscriptionID

@NotNull
public java.lang.String getSubscriptionID()

Retrieves the notification subscription ID.

Returns:

The notification subscription ID.

getSubscriptionDetails

@NotNull
public java.util.List<ASN1OctetString> getSubscriptionDetails()

Retrieves the implementation-specific details for the notification subscription.

Returns:

The implementation-specific details for the notification subscription.

duplicate

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