|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.ListConfigurationsExtendedResult
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListConfigurationsExtendedResult
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 result 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.
ListConfigurationsResult ::= SEQUENCE { activeConfigFileName [0] OCTET STRING, baselineConfigFileNames [1] OCTET STRING OPTIONAL, archivedConfigFileNames [2] SEQUENCE OF OCTET STRING OPTIONAL, ... }
Field Summary | |
---|---|
static java.lang.String |
LIST_CONFIGS_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.27) for the list configurations extended result. |
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
ListConfigurationsExtendedResult(ExtendedResult result)
Creates a new list configurations extended result from the provided generic extended result. |
|
ListConfigurationsExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
java.lang.String activeFileName,
java.util.Collection<java.lang.String> baselineFileNames,
java.util.Collection<java.lang.String> archivedFileNames,
Control... responseControls)
Creates a new list configurations extended result with the provided information. |
Method Summary | |
---|---|
static ASN1OctetString |
encodeValue(java.lang.String activeFileName,
java.util.Collection<java.lang.String> baselineFileNames,
java.util.Collection<java.lang.String> archivedFileNames)
Creates an ASN.1 octet string containing an encoded representation of the value for a list configurations extended result with the provided information. |
java.lang.String |
getActiveFileName()
Retrieves the name of the active configuration file the server is currently using, if available. |
java.util.List<java.lang.String> |
getArchivedFileNames()
Retrieves a list containing the names of the archived configuration files, if available. |
java.util.List<java.lang.String> |
getBaselineFileNames()
Retrieves a list containing the names of the baseline configuration files (i.e., the files containing the initial "out-of-the-box" configuration for various server versions), if available. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended response to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult |
---|
getOID, getValue, hasValue, toString |
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult |
---|
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl |
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_RESULT_OID
Constructor Detail |
---|
public ListConfigurationsExtendedResult(ExtendedResult result) throws LDAPException
result
- The generic extended result to be decoded as a list
configurations extended result.
LDAPException
- If the provided extended result cannot be parsed as
a valid list configurations extended result.public ListConfigurationsExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String activeFileName, java.util.Collection<java.lang.String> baselineFileNames, java.util.Collection<java.lang.String> archivedFileNames, Control... responseControls)
messageID
- The message ID for the LDAP message that is
associated with this LDAP result.resultCode
- The result code from the response.diagnosticMessage
- The diagnostic message from the response, if
available.matchedDN
- The matched DN from the response, if available.referralURLs
- The set of referral URLs from the response, if
available.activeFileName
- The name of the active configuration file, if
available.baselineFileNames
- The names of the baseline configuration files
for current and former server versions, if
available. It must be null
or empty if
the active file name is null
.archivedFileNames
- The names of the archived configuration files,
if available. It must be null
or empty
if the active file name is null
.responseControls
- The set of controls from the response, if
available.Method Detail |
---|
public static ASN1OctetString encodeValue(java.lang.String activeFileName, java.util.Collection<java.lang.String> baselineFileNames, java.util.Collection<java.lang.String> archivedFileNames)
activeFileName
- The name of the active configuration file, if
available.baselineFileNames
- The names of the baseline configuration files
for current and former server versions, if
available. It must be null
or empty if
the active file name is null
.archivedFileNames
- The names of the archived configuration files,
if available. It must be null
or empty
if the active file name is null
.
null
if a result with the provided information should not have a value.public java.lang.String getActiveFileName()
null
this is not available.public java.util.List<java.lang.String> getBaselineFileNames()
public java.util.List<java.lang.String> getArchivedFileNames()
public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended response will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |