Package org.ldaptive.ssl

Class X509CredentialConfig

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.ssl.X509CredentialConfig

All Implemented Interfaces:

Freezable, CredentialConfig

public class X509CredentialConfig
extends AbstractFreezable
implements CredentialConfig

Provides the properties necessary for creating an SSL context initializer with an X.509 credential reader.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	X509CredentialConfig.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private String	authenticationCertificate	Name of the authentication certificate to use for the SSL connection.
private String	authenticationKey	Name of the key to use for the SSL connection.
private X509CertificateCredentialReader	certReader	Reads X.509 certificate credential.
private X509CertificatesCredentialReader	certsReader	Reads X.509 certificates credential.
private static int	HASH_CODE_SEED	hash code seed.
private PrivateKeyCredentialReader	keyReader	Reads private key credential.
private String	trustCertificates	Name of the trust certificates to use for the SSL connection.

Constructor Summary

Constructors

Constructor	Description
X509CredentialConfig()

Method Summary

Modifier and Type	Method	Description
static X509CredentialConfig.Builder	builder()	Creates a builder for this class.
SSLContextInitializer	createSSLContextInitializer()	Creates an SSL context initializer using the configured trust and authentication material in this config.
boolean	equals(Object o)
String	getAuthenticationCertificate()	Returns the name of the authentication certificate to use.
String	getAuthenticationKey()	Returns the name of the authentication key to use.
String	getTrustCertificates()	Returns the name of the trust certificates to use.
int	hashCode()
void	setAuthenticationCertificate(String name)	Sets the name of the authentication certificate to use.
void	setAuthenticationKey(String name)	Sets the name of the authentication key to use.
void	setTrustCertificates(String name)	Sets the name of the trust certificates to use.
String	toString()

Methods inherited from class org.ldaptive.AbstractFreezable

assertMutable, freeze, freeze, freeze, isFrozen

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

certsReader

private final X509CertificatesCredentialReader certsReader

Reads X.509 certificates credential.

certReader

private final X509CertificateCredentialReader certReader

Reads X.509 certificate credential.

keyReader

private final PrivateKeyCredentialReader keyReader

Reads private key credential.

trustCertificates

private String trustCertificates

Name of the trust certificates to use for the SSL connection.

authenticationCertificate

private String authenticationCertificate

Name of the authentication certificate to use for the SSL connection.

authenticationKey

private String authenticationKey

Name of the key to use for the SSL connection.

Constructor Detail

X509CredentialConfig

public X509CredentialConfig()

Method Detail

getTrustCertificates

public String getTrustCertificates()

Returns the name of the trust certificates to use.

Returns:

trust certificates name

setTrustCertificates

public void setTrustCertificates(String name)

Sets the name of the trust certificates to use.

Parameters:

name - trust certificates name

getAuthenticationCertificate

public String getAuthenticationCertificate()

Returns the name of the authentication certificate to use.

Returns:

authentication certificate name

setAuthenticationCertificate

public void setAuthenticationCertificate(String name)

Sets the name of the authentication certificate to use.

Parameters:

name - authentication certificate name

getAuthenticationKey

public String getAuthenticationKey()

Returns the name of the authentication key to use.

Returns:

authentication key name

setAuthenticationKey

public void setAuthenticationKey(String name)

Sets the name of the authentication key to use.

Parameters:

name - authentication key name

createSSLContextInitializer

public SSLContextInitializer createSSLContextInitializer()
                                                  throws GeneralSecurityException

Description copied from interface: CredentialConfig

Creates an SSL context initializer using the configured trust and authentication material in this config.

Specified by:

createSSLContextInitializer in interface CredentialConfig

Returns:

SSL context initializer

Throws:

GeneralSecurityException - if the ssl context initializer cannot be created

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static X509CredentialConfig.Builder builder()

Creates a builder for this class.

Returns:

new builder