|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.SetNotificationDestinationExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SetNotificationDestinationExtendedRequest
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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:
SetNotificationDestinationRequest ::= SEQUENCE { notificationManagerID OCTET STRING, notificationDestinationID OCTET STRING, destinationDetails SEQUENCE OF OCTET STRING, changeType [0] ENUMERATED { replace (0), add (1), delete (2) } DEFAULT replace }
Field Summary | |
---|---|
static java.lang.String |
SET_NOTIFICATION_DESTINATION_REQUEST_OID
The 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 | |
---|---|
SetNotificationDestinationExtendedRequest(ExtendedRequest extendedRequest)
Creates a new set notification destination extended request from the provided generic extended request. |
|
SetNotificationDestinationExtendedRequest(java.lang.String managerID,
java.lang.String destinationID,
ASN1OctetString... destinationDetails)
Creates a new set notification destination extended request with the provided information. |
|
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. |
|
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. |
Method Summary | |
---|---|
SetNotificationDestinationExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
SetNotificationDestinationExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
SetNotificationDestinationChangeType |
getChangeType()
Retrieves the change type for the destination details. |
java.util.List<ASN1OctetString> |
getDestinationDetails()
Retrieves the implementation-specific details for the notification destination. |
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. |
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, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SET_NOTIFICATION_DESTINATION_REQUEST_OID
Constructor Detail |
---|
public SetNotificationDestinationExtendedRequest(java.lang.String managerID, java.lang.String destinationID, ASN1OctetString... destinationDetails)
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.public SetNotificationDestinationExtendedRequest(java.lang.String managerID, java.lang.String destinationID, java.util.Collection<ASN1OctetString> destinationDetails, Control... controls)
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.public SetNotificationDestinationExtendedRequest(java.lang.String managerID, java.lang.String destinationID, java.util.Collection<ASN1OctetString> destinationDetails, SetNotificationDestinationChangeType changeType, Control... controls)
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.public SetNotificationDestinationExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to use to create this
set notification destination extended request.
LDAPException
- If a problem occurs while decoding the request.Method Detail |
---|
public java.lang.String getManagerID()
public java.lang.String getDestinationID()
public java.util.List<ASN1OctetString> getDestinationDetails()
public SetNotificationDestinationChangeType getChangeType()
public SetNotificationDestinationExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public SetNotificationDestinationExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |