|
|||||||||
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.GetConfigurationExtendedResult
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetConfigurationExtendedResult
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.
GetConfigurationResult ::= SEQUENCE { configurationType [0] ENUMERATED { active (0), baseline (1), archived (2), ... }, fileName [1] OCTET STRING, configurationFileData [2] OCTET STRING, ... }
GetConfigurationExtendedRequest
,
ListConfigurationsExtendedRequest
,
Serialized FormField 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 |
---|
public static final java.lang.String GET_CONFIG_RESULT_OID
Constructor Detail |
---|
public GetConfigurationExtendedResult(ExtendedResult result) throws LDAPException
result
- The generic extended result to be decoded as a get
configuration extended result.
LDAPException
- If the provided extended result cannot be parsed as
a valid get configuration extended result.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)
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 |
---|
public static ASN1OctetString encodeValue(GetConfigurationType configurationType, java.lang.String fileName, byte[] fileData)
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.
null
if
a result with the provided information should not have a value.public GetConfigurationType getConfigurationType()
null
if this is not available.public java.lang.String getFileName()
null
if this is not available.public byte[] getFileData()
null
if this is not available.public java.io.InputStream getFileDataInputStream()
null
if this is not available.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 |