com.unboundid.ldap.sdk.unboundidds.extensions

Class GetConfigurationExtendedRequest

java.lang.Object

com.unboundid.ldap.sdk.LDAPRequest

com.unboundid.ldap.sdk.ExtendedRequest

com.unboundid.ldap.sdk.unboundidds.extensions.GetConfigurationExtendedRequest

All Implemented Interfaces:

ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetConfigurationExtendedRequest
extends ExtendedRequest

This class provides an implementation of an extended request that can be used to retrieve a version of the server configuration. It may be the active configuration, the baseline configuration, or any of the archived configurations. The set of available configurations that may be retrieved can be obtained using the ListConfigurationsExtendedRequest.

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.28. It must have a value with the following encoding:

   GetConfigurationRequest ::= SEQUENCE {
        requestType     CHOICE {
             activeConfiguration       [0] NULL,
             baselineConfiguration     [1] OCTET STRING,
             archivedConfiguration     [2] OCTET STRING,
             ... },
        ... }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_CONFIG_REQUEST_OID The OID (1.3.6.1.4.1.30221.2.6.28) for the get configuration extended request.

Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest

TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE

Constructor Summary

Constructors

Constructor and Description
GetConfigurationExtendedRequest(ExtendedRequest r) Creates a new get configuration extended request that has been decoded from the provided generic extended request.

Method Summary

Modifier and Type	Method and Description
static GetConfigurationExtendedRequest	createGetActiveConfigurationRequest(Control... controls) Creates a new get configuration extended request that may be used to retrieve the current active configuration.
static GetConfigurationExtendedRequest	createGetArchivedConfigurationRequest(java.lang.String fileName, Control... controls) Creates a new get configuration extended request that may be used to retrieve the baseline configuration for the current server version.
static GetConfigurationExtendedRequest	createGetBaselineConfigurationRequest(java.lang.String fileName, Control... controls) Creates a new get configuration extended request that may be used to retrieve the baseline configuration for the current server version.
GetConfigurationExtendedRequest	duplicate() Creates a new instance of this LDAP request that may be modified without impacting this request.
GetConfigurationExtendedRequest	duplicate(Control[] controls) Creates a new instance of this LDAP request that may be modified without impacting this request.
GetConfigurationType	getConfigurationType() Retrieves the type of configuration file that should be requested.
java.lang.String	getExtendedRequestName() Retrieves the user-friendly name for the extended request, if available.
java.lang.String	getFileName() Retrieves the name of the configuration file that should be requested, if applicable.
GetConfigurationExtendedResult	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, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GET_CONFIG_REQUEST_OID

@NotNull
public static final java.lang.String GET_CONFIG_REQUEST_OID

The OID (1.3.6.1.4.1.30221.2.6.28) for the get configuration extended request.

See Also:

Constant Field Values

Constructor Detail

GetConfigurationExtendedRequest

public GetConfigurationExtendedRequest(@NotNull
                                       ExtendedRequest r)
                                throws LDAPException

Creates a new get configuration extended request that has been decoded from the provided generic extended request.

Parameters:

r - The generic extended request to decode as a get configuration extended request.

Throws:

LDAPException - If the provided request cannot be decoded as a get configuration extended request.

Method Detail

createGetActiveConfigurationRequest

@NotNull
public static GetConfigurationExtendedRequest createGetActiveConfigurationRequest(@Nullable
                                                                                           Control... controls)

Creates a new get configuration extended request that may be used to retrieve the current active configuration.

Parameters:

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.

Returns:

The get configuration extended request that has been created.

createGetBaselineConfigurationRequest

@NotNull
public static GetConfigurationExtendedRequest createGetBaselineConfigurationRequest(@NotNull
                                                                                             java.lang.String fileName,
                                                                                             @Nullable
                                                                                             Control... controls)

Creates a new get configuration extended request that may be used to retrieve the baseline configuration for the current server version.

Parameters:

fileName - The name of the archived configuration file to retrieve. This must not be null.

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.

Returns:

The get configuration extended request that has been created.

createGetArchivedConfigurationRequest

@NotNull
public static GetConfigurationExtendedRequest createGetArchivedConfigurationRequest(@NotNull
                                                                                             java.lang.String fileName,
                                                                                             @Nullable
                                                                                             Control... controls)

Creates a new get configuration extended request that may be used to retrieve the baseline configuration for the current server version.

Parameters:

fileName - The name of the archived configuration file to retrieve. This must not be null.

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.

Returns:

The get configuration extended request that has been created.

getConfigurationType

@NotNull
public GetConfigurationType getConfigurationType()

Retrieves the type of configuration file that should be requested.

Returns:

The type of configuration file that should be requested.

getFileName

@Nullable
public java.lang.String getFileName()

Retrieves the name of the configuration file that should be requested, if applicable. This will only be available for requests that intend to retrieve a baseline or archived configuration.

Returns:

The name of the configuration file that should be requested, or null if this is not applicable.

process

@NotNull
public GetConfigurationExtendedResult 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 class ExtendedRequest

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 GetConfigurationExtendedRequest 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 interface ReadOnlyLDAPRequest

Overrides:

duplicate in class ExtendedRequest

Returns:

A new instance of this LDAP request that may be modified without impacting this request.

duplicate

@NotNull
public GetConfigurationExtendedRequest 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 interface ReadOnlyLDAPRequest

Overrides:

duplicate in class ExtendedRequest

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 class ExtendedRequest

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 interface ProtocolOp

Specified by:

toString in interface ReadOnlyLDAPRequest

Overrides:

toString in class ExtendedRequest

Parameters:

buffer - The buffer to which to append a string representation of this request.