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

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.GetConfigurationExtendedResult
All Implemented Interfaces:
LDAPResponse, java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetConfigurationExtendedResult
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 version of the server configuration.

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:
GetConfigurationExtendedRequest, ListConfigurationsExtendedRequest, Serialized Form

Field Summary
static java.lang.String GET_CONFIG_RESULT_OID
          The OID (1.3.6.1.4.1.30221.2.6.29) for the get configuration extended result.
 
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
 
Constructor Summary
GetConfigurationExtendedResult(ExtendedResult result)
          Creates a new get configuration extended result from the provided generic extended result.
GetConfigurationExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, GetConfigurationType configurationType, java.lang.String fileName, byte[] fileData, Control... responseControls)
          Creates a new get configuration extended result with the provided information.
 
Method Summary
static ASN1OctetString encodeValue(GetConfigurationType configurationType, java.lang.String fileName, 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.
 GetConfigurationType getConfigurationType()
          Retrieves the type of configuration that has been returned, if available.
 java.lang.String getExtendedResultName()
          Retrieves the user-friendly name for the extended result, if available.
 byte[] getFileData()
          Retrieves the raw data for the configuration file that has been returned, if available.
 java.io.InputStream getFileDataInputStream()
          Retrieves an input stream that may be used to read the file data that has been returned, if available.
 java.lang.String getFileName()
          Retrieves the name of the configuration file that has been returned, 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

GET_CONFIG_RESULT_OID

public static final java.lang.String GET_CONFIG_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.29) for the get configuration extended result.

See Also:
Constant Field Values
Constructor Detail

GetConfigurationExtendedResult

public GetConfigurationExtendedResult(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,
                                      ResultCode resultCode,
                                      java.lang.String diagnosticMessage,
                                      java.lang.String matchedDN,
                                      java.lang.String[] referralURLs,
                                      GetConfigurationType configurationType,
                                      java.lang.String fileName,
                                      byte[] fileData,
                                      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 Detail

encodeValue

public static ASN1OctetString encodeValue(GetConfigurationType configurationType,
                                          java.lang.String fileName,
                                          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

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

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

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

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

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.