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

Class GetConfigurationExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.GetConfigurationExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetConfigurationExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that can be used to retrieve a version of the server configuration.
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.29. If the request was processed successfully, then the response will have a value with the following encoding: 
   GetConfigurationResult ::= SEQUENCE {
        configurationType         [0] ENUMERATED {
             active       (0),
             baseline     (1),
             archived     (2),
             ... },
        fileName                  [1] OCTET STRING,
        configurationFileData     [2] OCTET STRING,
        ... }
See Also:

  • Field Details

  • Constructor Details

    • GetConfigurationExtendedResult

      public GetConfigurationExtendedResult(@NotNull ExtendedResult result) throws LDAPException
      Creates a new get configuration extended result from the provided generic extended result.
      Parameters:
      result - The generic extended result to be decoded as a get configuration extended result.
      Throws:
      LDAPException - If the provided extended result cannot be parsed as a valid get configuration extended result.

    • GetConfigurationExtendedResult

      public GetConfigurationExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable GetConfigurationType configurationType, @Nullable String fileName, @Nullable byte[] fileData, @Nullable Control... responseControls)
      Creates a new get configuration 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.
      configurationType - The type of configuration that has been returned.
      fileName - The name of the configuration file that has been returned.
      fileData - The raw data for the configuration file that has been returned.
      responseControls - The set of controls from the response, if available.

  • Method Details

    • encodeValue

      @Nullable public static ASN1OctetString encodeValue(@Nullable GetConfigurationType configurationType, @Nullable String fileName, @Nullable byte[] fileData)
      Creates an ASN.1 octet string containing an encoded representation of the value for a get configuration extended result with the provided information.
      Parameters:
      configurationType - The type of configuration that has been returned.
      fileName - The name of the configuration file that has been returned.
      fileData - The raw data for the configuration file that has been returned.
      Returns:
      An ASN.1 octet string containing an encoded representation of the value for a get configuration extended result, or null if a result with the provided information should not have a value.

    • getConfigurationType

      @Nullable public GetConfigurationType getConfigurationType()
      Retrieves the type of configuration that has been returned, if available.
      Returns:
      The type of configuration that has been returned, or null if this is not available.

    • getFileName

      @Nullable public String getFileName()
      Retrieves the name of the configuration file that has been returned, if available.
      Returns:
      The name of the configuration file that has been returned, or null if this is not available.

    • getFileData

      @Nullable public byte[] getFileData()
      Retrieves the raw data for the configuration file that has been returned, if available.
      Returns:
      The raw data for the configuration file that has been returned, or null if this is not available.

    • getFileDataInputStream

      @Nullable public InputStream getFileDataInputStream()
      Retrieves an input stream that may be used to read the file data that has been returned, if available.
      Returns:
      An input stream that may be used to read the file data that has been returned, or null 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.