Class KeyStoreFileReplaceCertificateKeyStoreContent
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.extensions.ReplaceCertificateKeyStoreContent
-
- com.unboundid.ldap.sdk.unboundidds.extensions.KeyStoreFileReplaceCertificateKeyStoreContent
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class KeyStoreFileReplaceCertificateKeyStoreContent extends ReplaceCertificateKeyStoreContent
This class provides aReplaceCertificateKeyStoreContent
implementation to indicate that the server should use a certificate key store file contained on the server filesystem.
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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description KeyStoreFileReplaceCertificateKeyStoreContent(java.lang.String keyStorePath, java.lang.String keyStorePIN, java.lang.String privateKeyPIN, java.lang.String keyStoreType, java.lang.String sourceCertificateAlias)
Creates a new instance of this key store content object with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ASN1Element
encode()
Encodes this key store content object to an ASN.1 element suitable for inclusion in either a replace listener certificate or replace inter-server certificate request.java.lang.String
getKeyStorePath()
Retrieves the absolute path to the target key store on the server filesystem.java.lang.String
getKeyStorePIN()
Retrieves the PIN needed to access protected content in the key store.java.lang.String
getKeyStoreType()
Retrieves the key store type for the target key store, if available.java.lang.String
getPrivateKeyPIN()
Retrieves the PIN needed to access private key information in the key store, if available.java.lang.String
getSourceCertificateAlias()
Retrieves the alias of the private key entry in the key store that contains the new certificate chain to be used, if available.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this key store content object to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.extensions.ReplaceCertificateKeyStoreContent
decode, toString
-
-
-
-
Constructor Detail
-
KeyStoreFileReplaceCertificateKeyStoreContent
public KeyStoreFileReplaceCertificateKeyStoreContent(@NotNull java.lang.String keyStorePath, @NotNull java.lang.String keyStorePIN, @Nullable java.lang.String privateKeyPIN, @Nullable java.lang.String keyStoreType, @Nullable java.lang.String sourceCertificateAlias)
Creates a new instance of this key store content object with the provided information.- Parameters:
keyStorePath
- The absolute path to the target key store on the server filesystem. It must not benull
or empty.keyStorePIN
- The PIN needed to access protected content in the key store. It must not benull
or empty.privateKeyPIN
- The PIN needed to access private key information in the key store. It may benull
if the key store PIN should also be used as the private key PIN.keyStoreType
- The key store type for the target key store. If provided, its value will likely be one of JKS, PKCS12, or BCFKS. If this isnull
, then the server will attempt to automatically determine the appropriate key store type.sourceCertificateAlias
- The alias of the private key entry in the key store that contains the new certificate chain to be used. It may optionally benull
if and only if the key store has only a single private key entry.
-
-
Method Detail
-
getKeyStorePath
@NotNull public java.lang.String getKeyStorePath()
Retrieves the absolute path to the target key store on the server filesystem.- Returns:
- The absolute path to the target key store on the server filesystem.
-
getKeyStorePIN
@NotNull public java.lang.String getKeyStorePIN()
Retrieves the PIN needed to access protected content in the key store.- Returns:
- The PIN needed to access protected content in the key store.
-
getPrivateKeyPIN
@Nullable public java.lang.String getPrivateKeyPIN()
Retrieves the PIN needed to access private key information in the key store, if available.- Returns:
- The PIN needed to access private key information in the key store,
or
null
if the key store PIN should also be used as the private key PIN.
-
getKeyStoreType
@Nullable public java.lang.String getKeyStoreType()
Retrieves the key store type for the target key store, if available.- Returns:
- The key store type for the target key store, or
null
if the key store type is not available and the server should attempt to automatically determine the appropriate key store type.
-
getSourceCertificateAlias
@Nullable public java.lang.String getSourceCertificateAlias()
Retrieves the alias of the private key entry in the key store that contains the new certificate chain to be used, if available.- Returns:
- The alias of the private key entry in the key store that contains
the new certificate chain to be used, or
null
if no source certificate alias was provided and the key store is expected to have only a single private key entry.
-
encode
@NotNull public ASN1Element encode()
Encodes this key store content object to an ASN.1 element suitable for inclusion in either a replace listener certificate or replace inter-server certificate request.- Specified by:
encode
in classReplaceCertificateKeyStoreContent
- Returns:
- The ASN.1 element containing an encoded representation of this key store content object.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this key store content object to the provided buffer.- Specified by:
toString
in classReplaceCertificateKeyStoreContent
- Parameters:
buffer
- The buffer to which the encoded representation should be appended. It must not benull
.
-
-