com.unboundid.ldap.sdk.unboundidds.extensions

Class ReplaceCertificateExtendedResult

java.lang.Object

com.unboundid.ldap.sdk.LDAPResult

com.unboundid.ldap.sdk.ExtendedResult

com.unboundid.ldap.sdk.unboundidds.extensions.ReplaceCertificateExtendedResult

All Implemented Interfaces:

LDAPResponse, java.io.Serializable

Direct Known Subclasses:

PurgeRetiredInterServerCertificatesExtendedResult, PurgeRetiredListenerCertificatesExtendedResult, ReplaceInterServerCertificateExtendedResult, ReplaceListenerCertificateExtendedResult

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class ReplaceCertificateExtendedResult
extends ExtendedResult

This class defines the superclass for extended results that may be returned in response to the replace certificate extended requests, including ReplaceListenerCertificateExtendedRequest, ReplaceInterServerCertificateExtendedRequest, PurgeRetiredListenerCertificatesExtendedRequest, and PurgeRetiredInterServerCertificatesExtendedRequest.

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 extended result may have an OID that matches that of the associated extended result, and it may have a value with the following encoding:

   ReplaceCertificateResponseValue ::= SEQUENCE {
     toolOutput     [16] OCTET STRING OPTIONAL,
    ... }
 

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse

NO_CONTROLS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReplaceCertificateExtendedResult(ExtendedResult extendedResult) Creates a new replace certificate extended result that is decoded from the provided extended result.
protected	ReplaceCertificateExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String oid, java.lang.String toolOutput, Control... responseControls) Creates a new replace certificate extended result with the provided information.

Method Summary

Modifier and Type	Method and Description
static ASN1OctetString	encodeValue(java.lang.String oid, java.lang.String toolOutput) Encodes a value for this extended result, if appropriate.
java.lang.String	getToolOutput() Retrieves the output (a combined representation of both standard output and standard error) obtained from running the replace-certificate tool, if available.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this replace certificate result to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult

getExtendedResultName, getOID, getValue, hasValue, toString

Methods inherited from class com.unboundid.ldap.sdk.LDAPResult

getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplaceCertificateExtendedResult

protected ReplaceCertificateExtendedResult(@NotNull
                                           ExtendedResult extendedResult)
                                    throws LDAPException

Creates a new replace certificate extended result that is decoded from the provided extended result.

Parameters:

extendedResult - The generic extended result to decode as a replace certificate extended result. It must not be null.

Throws:

LDAPException - If the provided extended result cannot be decoded as a replace certificate extended result.

ReplaceCertificateExtendedResult

protected ReplaceCertificateExtendedResult(int messageID,
                                           @NotNull
                                           ResultCode resultCode,
                                           @Nullable
                                           java.lang.String diagnosticMessage,
                                           @Nullable
                                           java.lang.String matchedDN,
                                           @Nullable
                                           java.lang.String[] referralURLs,
                                           @Nullable
                                           java.lang.String oid,
                                           @Nullable
                                           java.lang.String toolOutput,
                                           @Nullable
                                           Control... responseControls)

Creates a new replace certificate 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.

oid - The OID to use for the extended result. It may be null if no OID should be used.

toolOutput - The output (a combined representation of both standard output and standard error) obtained from running the replace-certificate tool. It may be null if request processing failed before running the tool.

responseControls - The set of controls to include in the extended result. It may be null or empty if no response controls should be included.

Method Detail

encodeValue

@Nullable
public static ASN1OctetString encodeValue(@Nullable
                                                    java.lang.String oid,
                                                    @Nullable
                                                    java.lang.String toolOutput)

Encodes a value for this extended result, if appropriate.

Parameters:

oid - The OID to use for the extended result. It may be null if no OID should be used.

toolOutput - The output obtained from running the replace-certificate tool. It may be null if request processing failed before running the tool.

Returns:

The encoded value for this extended result, or null if no value should be included.

getToolOutput

@Nullable
public java.lang.String getToolOutput()

Retrieves the output (a combined representation of both standard output and standard error) obtained from running the replace-certificate tool, if available.

Returns:

The output obtained from running the replace-certificate tool, or null if no output is available (e.g., because an error occurred before the tool could be invoked).

toString

public final void toString(@NotNull
                           java.lang.StringBuilder buffer)

Appends a string representation of this replace certificate result to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class ExtendedResult

Parameters:

buffer - The buffer to which the information should be appended. It must not be null.