Class ReplaceInterServerCertificateExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.unboundidds.extensions.ReplaceInterServerCertificateExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReplaceInterServerCertificateExtendedRequest extends ExtendedRequest
This class defines an extended request that may be used to request that a Ping Identity Directory Server instance (or related Ping Identity server product) replace its inter-server certificate. The new certificate data may be contained in a key store file on the server filesystem or included in the extended request itself.
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.
This extended request has an OID of 1.3.6.1.4.1.30221.2.6.69 and a value with the following encoding:ReplaceInterServerCertificateValue ::= SEQUENCE { keyStoreContent CHOICE { keyStoreFile [0] KeyStoreFileSequence, keyStoreData [1] KeyStoreDataSequence, certificateData [2] CertificateDataSequence, ... }, skipCertificateValidation [16] BOOLEAN DEFAULT FALSE, ... } KeyStoreFileSequence ::= SEQUENCE { path [8] OCTET STRING, keyStorePIN [9] OCTET STRING, privateKeyPIN [10] OCTET STRING OPTIONAL, keyStoreType [11] OCTET STRING OPTIONAL, sourceCertificateAlias [12] OCTET STRING OPTIONAL, ... } KeyStoreDataSequence ::= SEQUENCE { keyStoreData [13] OCTET STRING, keyStorePIN [9] OCTET STRING, privateKeyPIN [10] OCTET STRING OPTIONAL, keyStoreType [11] OCTET STRING OPTIONAL, sourceCertificateAlias [12] OCTET STRING OPTIONAL, ... } CertificateDataSequence ::= SEQUENCE { certificateChain [14] SEQUENCE SIZE (1..MAX) OF OCTET STRING, privateKey [15] OCTET STRING OPTIONAL, ... }
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
REPLACE_INTER_SERVER_CERT_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.69) for the replace inter-server certificate extended request.-
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
-
-
Constructor Summary
Constructors Constructor Description ReplaceInterServerCertificateExtendedRequest(ExtendedRequest request)
Creates a new replace inter-server certificate extended request that is decoded from the provided generic extended request.ReplaceInterServerCertificateExtendedRequest(ReplaceCertificateKeyStoreContent keyStoreContent, boolean skipCertificateValidation, Control... requestControls)
Creates a new replace inter-server certificate extended request with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.ReplaceCertificateKeyStoreContent
getKeyStoreContent()
Retrieves an object with information about how the server should obtain the new inter-server certificate data.ReplaceInterServerCertificateExtendedResult
process(LDAPConnection connection, int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response.boolean
skipCertificateValidation()
Indicates whether the server should skip validation processing for the new certificate chain.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest
duplicate, duplicate, encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
REPLACE_INTER_SERVER_CERT_REQUEST_OID
@NotNull public static final java.lang.String REPLACE_INTER_SERVER_CERT_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.69) for the replace inter-server certificate extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ReplaceInterServerCertificateExtendedRequest
public ReplaceInterServerCertificateExtendedRequest(@NotNull ReplaceCertificateKeyStoreContent keyStoreContent, boolean skipCertificateValidation, @Nullable Control... requestControls)
Creates a new replace inter-server certificate extended request with the provided information.- Parameters:
keyStoreContent
- An object with information about how the server should obtain the new inter-server certificate data. It must not benull
.skipCertificateValidation
- Indicates whether to skip validation for the new certificate chain.requestControls
- The set of controls to include in the extended request. It may benull
or empty if no request controls should be included.
-
ReplaceInterServerCertificateExtendedRequest
public ReplaceInterServerCertificateExtendedRequest(@NotNull ExtendedRequest request) throws LDAPException
Creates a new replace inter-server certificate extended request that is decoded from the provided generic extended request.- Parameters:
request
- The generic extended request to be decoded as a replace inter-server certificate extended request. It must not benull
.- Throws:
LDAPException
- If a problem occurs while attempting to decode the provided extended request as a replace inter-server certificate request.
-
-
Method Detail
-
getKeyStoreContent
@NotNull public ReplaceCertificateKeyStoreContent getKeyStoreContent()
Retrieves an object with information about how the server should obtain the new inter-server certificate data.- Returns:
- An object with information about how the server should obtain the new inter-server certificate data.
-
skipCertificateValidation
public boolean skipCertificateValidation()
Indicates whether the server should skip validation processing for the new certificate chain.- Returns:
true
if the server should skip validation processing for the new certificate chain, orfalse
if not.
-
process
@NotNull public ReplaceInterServerCertificateExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.- Overrides:
process
in classExtendedRequest
- Parameters:
connection
- The connection to use to communicate with the directory server.depth
- The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.- Returns:
- An LDAP result object that provides information about the result of the extended operation processing.
- Throws:
LDAPException
- If a problem occurs while sending the request or reading the response.
-
getExtendedRequestName
@NotNull public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getExtendedRequestName
in classExtendedRequest
- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-