@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetConfigurationExtendedRequest extends ExtendedRequest
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 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.
GetConfigurationRequest ::= SEQUENCE { requestType CHOICE { activeConfiguration [0] NULL, baselineConfiguration [1] OCTET STRING, archivedConfiguration [2] OCTET STRING, ... }, ... }
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.
|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
Constructor and Description |
---|
GetConfigurationExtendedRequest(ExtendedRequest r)
Creates a new get configuration extended request that has been decoded from
the provided generic extended request.
|
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.
|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
public static final java.lang.String GET_CONFIG_REQUEST_OID
public GetConfigurationExtendedRequest(ExtendedRequest r) throws LDAPException
r
- The generic extended request to decode as a get configuration
extended request.LDAPException
- If the provided request cannot be decoded as a get
configuration extended request.public static GetConfigurationExtendedRequest createGetActiveConfigurationRequest(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 static GetConfigurationExtendedRequest createGetBaselineConfigurationRequest(java.lang.String fileName, Control... controls)
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.public static GetConfigurationExtendedRequest createGetArchivedConfigurationRequest(java.lang.String fileName, Control... controls)
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.public GetConfigurationType getConfigurationType()
public java.lang.String getFileName()
null
if this is not applicable.public GetConfigurationExtendedResult 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 GetConfigurationExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public GetConfigurationExtendedRequest 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.