Class SetNotificationDestinationExtendedRequest
java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.SetNotificationDestinationExtendedRequest
- All Implemented Interfaces:
ProtocolOp,ReadOnlyLDAPRequest,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.
The request has an OID of 1.3.6.1.4.1.30221.2.6.36 and a value with the following encoding:
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe OID (1.3.6.1.4.1.30221.2.6.36) for the set notification destination extended request.Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE -
Constructor Summary
ConstructorsConstructorDescriptionSetNotificationDestinationExtendedRequest(ExtendedRequest extendedRequest) Creates a new set notification destination extended request from the provided generic extended request.SetNotificationDestinationExtendedRequest(String managerID, String destinationID, ASN1OctetString... destinationDetails) Creates a new set notification destination extended request with the provided information.SetNotificationDestinationExtendedRequest(String managerID, String destinationID, Collection<ASN1OctetString> destinationDetails, Control... controls) Creates a new set notification destination extended request with the provided information.SetNotificationDestinationExtendedRequest(String managerID, String destinationID, Collection<ASN1OctetString> destinationDetails, SetNotificationDestinationChangeType changeType, Control... controls) Creates a new set notification destination extended request with the provided information. -
Method Summary
Modifier and TypeMethodDescriptionCreates a new instance of this LDAP request that may be modified without impacting this request.Creates a new instance of this LDAP request that may be modified without impacting this request.Retrieves the change type for the destination details.Retrieves the implementation-specific details for the notification destination.Retrieves the notification destination ID.Retrieves the user-friendly name for the extended request, if available.Retrieves the notification manager ID.voidtoString(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, writeToMethods 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
-
Field Details
-
SET_NOTIFICATION_DESTINATION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.36) for the set notification destination extended request.- See Also:
-
-
Constructor Details
-
SetNotificationDestinationExtendedRequest
public SetNotificationDestinationExtendedRequest(@NotNull String managerID, @NotNull String destinationID, @NotNull ASN1OctetString... destinationDetails) Creates a new set notification destination extended request with the provided information.- Parameters:
managerID- The notification manager ID. It must not benull.destinationID- The notification destination ID. It must not benull.destinationDetails- The implementation-specific details for the notification destination. At least one detail value must be provided.
-
SetNotificationDestinationExtendedRequest
public SetNotificationDestinationExtendedRequest(@NotNull String managerID, @NotNull String destinationID, @NotNull Collection<ASN1OctetString> destinationDetails, @Nullable Control... controls) Creates a new set notification destination extended request with the provided information.- Parameters:
managerID- The notification manager ID. It must not benull.destinationID- The notification destination ID. It must not benull.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 benullor empty if no controls are needed.
-
SetNotificationDestinationExtendedRequest
public SetNotificationDestinationExtendedRequest(@NotNull String managerID, @NotNull String destinationID, @NotNull Collection<ASN1OctetString> destinationDetails, @Nullable SetNotificationDestinationChangeType changeType, @Nullable Control... controls) Creates a new set notification destination extended request with the provided information.- Parameters:
managerID- The notification manager ID. It must not benull.destinationID- The notification destination ID. It must not benull.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 benullor empty if no controls are needed.
-
SetNotificationDestinationExtendedRequest
public SetNotificationDestinationExtendedRequest(@NotNull 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 Details
-
getManagerID
Retrieves the notification manager ID.- Returns:
- The notification manager ID.
-
getDestinationID
Retrieves the notification destination ID.- Returns:
- The notification destination ID.
-
getDestinationDetails
Retrieves the implementation-specific details for the notification destination.- Returns:
- The implementation-specific details for the notification destination.
-
getChangeType
Retrieves the change type for the destination details.- Returns:
- The change type for the destination details.
-
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:
duplicatein interfaceReadOnlyLDAPRequest- Overrides:
duplicatein classExtendedRequest- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
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:
duplicatein interfaceReadOnlyLDAPRequest- Overrides:
duplicatein classExtendedRequest- 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
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:
getExtendedRequestNamein classExtendedRequest- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
Appends a string representation of this request to the provided buffer.- Specified by:
toStringin interfaceProtocolOp- Specified by:
toStringin interfaceReadOnlyLDAPRequest- Overrides:
toStringin classExtendedRequest- Parameters:
buffer- The buffer to which to append a string representation of this request.
-