|
|||||||||
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.ListConfigurationsExtendedRequest
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListConfigurationsExtendedRequest
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 implementation of an extended request that can be used to retrieve a list of all available versions of the configuration within a server. This may include not only the currently-active configuration, but also former configurations that have been archived, and the baseline configuration for the current server version.
// Get a list of the available configurations from the server. ListConfigurationsExtendedResult listConfigsResult = (ListConfigurationsExtendedResult) connection.processExtendedOperation( new ListConfigurationsExtendedRequest()); String archivedConfigFileName = listConfigsResult.getArchivedFileNames().get(0); // Retrieve the first archived configuration from the list configurations // result. GetConfigurationExtendedResult getConfigResult = (GetConfigurationExtendedResult) connection.processExtendedOperation(GetConfigurationExtendedRequest. createGetArchivedConfigurationRequest(archivedConfigFileName)); InputStream fileDataStream = getConfigResult.getFileDataInputStream(); // Read data from the file. fileDataStream.close();
GetConfigurationExtendedRequest
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
LIST_CONFIGS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.26) for the list configurations extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
ListConfigurationsExtendedRequest(Control... controls)
Creates a new list configurations extended request with the provided information. |
|
ListConfigurationsExtendedRequest(ExtendedRequest r)
Creates a new list configurations extended request that has been decoded from the provided generic extended request. |
Method Summary | |
---|---|
ListConfigurationsExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ListConfigurationsExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
ListConfigurationsExtendedResult |
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_CONFIGS_REQUEST_OID
Constructor Detail |
---|
public ListConfigurationsExtendedRequest(Control... controls)
controls
- An optional set of controls to include in the request.
This may be null
or empty if no controls should
be included in the request.public ListConfigurationsExtendedRequest(ExtendedRequest r) throws LDAPException
r
- The generic extended request to decode as a list configurations
extended request.
LDAPException
- If the provided request cannot be decoded as a
valid list configurations extended request.Method Detail |
---|
public ListConfigurationsExtendedResult 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 ListConfigurationsExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public ListConfigurationsExtendedRequest 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 |