Class ListConfigurationsExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.unboundidds.extensions.ListConfigurationsExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListConfigurationsExtendedRequest extends ExtendedRequest
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.
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 OID for this extended request is 1.3.6.1.4.1.30221.2.6.26. It does not have a value.
Example
The following example demonstrates the process for using the list configurations and get configuration extended requests to obtain the oldest archived configuration from the server:// 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();
- See Also:
GetConfigurationExtendedRequest
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
LIST_CONFIGS_REQUEST_OID
@NotNull public static final 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.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ListConfigurationsExtendedRequest
public ListConfigurationsExtendedRequest(@Nullable Control... controls)
Creates a new list configurations extended request with the provided information.- Parameters:
controls
- An optional set of controls to include in the request. This may benull
or empty if no controls should be included in the request.
-
ListConfigurationsExtendedRequest
public ListConfigurationsExtendedRequest(@NotNull ExtendedRequest r) throws LDAPException
Creates a new list configurations extended request that has been decoded from the provided generic extended request.- Parameters:
r
- The generic extended request to decode as a list configurations extended request.- Throws:
LDAPException
- If the provided request cannot be decoded as a valid list configurations extended request.
-
-
Method Detail
-
process
@NotNull public ListConfigurationsExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.- Overrides:
process
in classExtendedRequest
- Parameters:
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.- Returns:
- An LDAP result object that provides information about the result of the extended operation processing.
- Throws:
LDAPException
- If a problem occurs while sending the request or reading the response.
-
duplicate
@NotNull public ListConfigurationsExtendedRequest 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 interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
@NotNull public ListConfigurationsExtendedRequest 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 interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in 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
@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 classExtendedRequest
- 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 interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-