|
|||||||||
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.ListNotificationSubscriptionsExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListNotificationSubscriptionsExtendedRequest
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 retrieve a list of the subscriptions associated with a specified notification manager, optionally restricted to a specified set of destinations. 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 }
Field Summary | |
---|---|
static java.lang.String |
LIST_NOTIFICATION_SUBSCRIPTIONS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.40) for the list notification subscriptions extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
ListNotificationSubscriptionsExtendedRequest(ExtendedRequest extendedRequest)
Creates a new list notification subscriptions extended request from the provided generic extended request. |
|
ListNotificationSubscriptionsExtendedRequest(java.lang.String managerID,
java.util.Collection<java.lang.String> destinationIDs,
Control... controls)
Creates a new list notification subscriptions extended request with the provided information. |
|
ListNotificationSubscriptionsExtendedRequest(java.lang.String managerID,
java.lang.String... destinationIDs)
Creates a new list notification subscriptions extended request with the provided information. |
Method Summary | |
---|---|
ListNotificationSubscriptionsExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ListNotificationSubscriptionsExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.util.Set<java.lang.String> |
getDestinationIDs()
Retrieves the notification destination IDs, if any were provided. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
java.lang.String |
getManagerID()
Retrieves the notification manager ID. |
ListNotificationSubscriptionsExtendedResult |
process(LDAPConnection connection,
int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response. |
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, 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 LIST_NOTIFICATION_SUBSCRIPTIONS_REQUEST_OID
Constructor Detail |
---|
public ListNotificationSubscriptionsExtendedRequest(java.lang.String managerID, java.lang.String... destinationIDs)
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.public ListNotificationSubscriptionsExtendedRequest(java.lang.String managerID, java.util.Collection<java.lang.String> destinationIDs, Control... controls)
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.public ListNotificationSubscriptionsExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to use to create this
list notification subscriptions extended request.
LDAPException
- If a problem occurs while decoding the request.Method Detail |
---|
public ListNotificationSubscriptionsExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
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.
LDAPException
- If a problem occurs while sending the request or
reading the response.public java.lang.String getManagerID()
public java.util.Set<java.lang.String> getDestinationIDs()
public ListNotificationSubscriptionsExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public ListNotificationSubscriptionsExtendedRequest 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 |