com.unboundid.ldap.sdk.unboundidds.extensions
Class ListConfigurationsExtendedResult

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPResult
      extended by com.unboundid.ldap.sdk.ExtendedResult
          extended by com.unboundid.ldap.sdk.unboundidds.extensions.ListConfigurationsExtendedResult
All Implemented Interfaces:
LDAPResponse, java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ListConfigurationsExtendedResult
extends ExtendedResult

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.

The OID for this extended result is 1.3.6.1.4.1.30221.2.6.27. If the request was processed successfully, then the response will have a value with the following encoding:
   ListConfigurationsResult ::= SEQUENCE {
        activeConfigFileName        [0] OCTET STRING,
        baselineConfigFileNames     [1] OCTET STRING OPTIONAL,
        archivedConfigFileNames     [2] SEQUENCE OF OCTET STRING OPTIONAL,
        ... }
 

See Also:
Serialized Form

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

LIST_CONFIGS_RESULT_OID

public static final 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.

See Also:
Constant Field Values
Constructor Detail

ListConfigurationsExtendedResult

public ListConfigurationsExtendedResult(ExtendedResult result)
                                 throws LDAPException
Creates a new list configurations extended result from the provided generic extended result.

Parameters:
result - The generic extended result to be decoded as a list configurations extended result.
Throws:
LDAPException - If the provided extended result cannot be parsed as a valid list configurations extended result.

ListConfigurationsExtendedResult

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)
Creates a new list configurations extended result with the provided information.

Parameters:
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

encodeValue

public 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.

Parameters:
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.
Returns:
An ASN.1 octet string containing an encoded representation of the value for a list configurations extended result, or null if a result with the provided information should not have a value.

getActiveFileName

public java.lang.String getActiveFileName()
Retrieves the name of the active configuration file the server is currently using, if available.

Returns:
The name of the active configuration file the server is currently using, or null this is not available.

getBaselineFileNames

public 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.

Returns:
A list containing the names of the baseline configuration files, or an empty list if this is not available.

getArchivedFileNames

public java.util.List<java.lang.String> getArchivedFileNames()
Retrieves a list containing the names of the archived configuration files, if available.

Returns:
A list containing the names of the archived configuration files, or an empty list if this is not available.

getExtendedResultName

public java.lang.String getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.

Overrides:
getExtendedResultName in class ExtendedResult
Returns:
The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended response to the provided buffer.

Specified by:
toString in interface LDAPResponse
Overrides:
toString in class ExtendedResult
Parameters:
buffer - The buffer to which a string representation of this extended response will be appended.