Package com.unboundid.ldap.sdk.unboundidds.extensions

Class ListConfigurationsExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.ListConfigurationsExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ListConfigurationsExtendedResult extends ExtendedResult
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.
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 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:

  • Field Details

  • Constructor Details

    • ListConfigurationsExtendedResult

      public ListConfigurationsExtendedResult(@NotNull 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, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable String activeFileName, @Nullable Collection<String> baselineFileNames, @Nullable Collection<String> archivedFileNames, @Nullable 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 Details

    • encodeValue

      @Nullable public static ASN1OctetString encodeValue(@Nullable String activeFileName, @Nullable Collection<String> baselineFileNames, @Nullable Collection<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

      @Nullable public 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

      @Nullable public List<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

      @Nullable public List<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

      @NotNull public 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(@NotNull 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.