public class SecurityOptions extends Object
Modifier and Type | Class and Description |
---|---|
static class |
SecurityOptions.CertificateType
The different type of security options that we can have.
|
Modifier and Type | Field and Description |
---|---|
static String |
SELF_SIGNED_CERT_ALIAS
Alias of a self-signed certificate.
|
static String |
SELF_SIGNED_EC_CERT_ALIAS
Alias of a self-signed certificate using elliptic curve.
|
Modifier and Type | Method and Description |
---|---|
static SecurityOptions |
createJCEKSCertificateOptions(String keystorePath,
String keystorePwd,
boolean enableSSL,
boolean enableStartTLS,
int sslPort,
Collection<String> aliasesToUse)
Creates a new instance of a SecurityOptions using a JCE Key Store.
|
static SecurityOptions |
createJKSCertificateOptions(String keystorePath,
String keystorePwd,
boolean enableSSL,
boolean enableStartTLS,
int sslPort,
Collection<String> aliasesToUse)
Creates a new instance of a SecurityOptions using a Java Key Store.
|
static SecurityOptions |
createNoCertificateOptions()
Creates a new instance of a SecurityOptions representing for no certificate
(no SSL or Start TLS).
|
static SecurityOptions |
createOptionsForCertificatType(SecurityOptions.CertificateType certType,
String keystorePath,
String keystorePwd,
boolean enableSSL,
boolean enableStartTLS,
int sslPort,
Collection<String> aliasesToUse)
Creates a new instance of a SecurityOptions using the provided type Key
Store.
|
static SecurityOptions |
createPKCS11CertificateOptions(String keystorePwd,
boolean enableSSL,
boolean enableStartTLS,
int sslPort,
Collection<String> aliasesToUse)
Creates a new instance of a SecurityOptions using a PKCS#11 Key Store.
|
static SecurityOptions |
createPKCS12CertificateOptions(String keystorePath,
String keystorePwd,
boolean enableSSL,
boolean enableStartTLS,
int sslPort,
Collection<String> aliasesToUse)
Creates a new instance of a SecurityOptions using a PKCS#12 Key Store.
|
static SecurityOptions |
createSelfSignedCertificateOptions(boolean enableSSL,
boolean enableStartTLS,
int sslPort)
Creates a new instance of a SecurityOptions using a self-signed
certificate.
|
Set<String> |
getAliasesToUse()
Returns the alias of the certificate in the key store to be used.
|
SecurityOptions.CertificateType |
getCertificateType()
Returns the CertificateType for this instance.
|
boolean |
getEnableSSL()
Returns whether SSL is enabled or not.
|
boolean |
getEnableStartTLS()
Returns whether StartTLS is enabled or not.
|
String |
getKeystorePassword()
Returns the key store password.
|
String |
getKeystorePath()
Returns the key store path.
|
int |
getSslPort()
Returns the SSL port.
|
public static final String SELF_SIGNED_CERT_ALIAS
public static final String SELF_SIGNED_EC_CERT_ALIAS
public static SecurityOptions createNoCertificateOptions()
public static SecurityOptions createSelfSignedCertificateOptions(boolean enableSSL, boolean enableStartTLS, int sslPort)
enableSSL
- whether SSL is enabled or not.enableStartTLS
- whether Start TLS is enabled or not.sslPort
- the value of the LDAPS port.public static SecurityOptions createJKSCertificateOptions(String keystorePath, String keystorePwd, boolean enableSSL, boolean enableStartTLS, int sslPort, Collection<String> aliasesToUse)
keystorePath
- the path of the key store.keystorePwd
- the password of the key store.enableSSL
- whether SSL is enabled or not.enableStartTLS
- whether Start TLS is enabled or not.sslPort
- the value of the LDAPS port.aliasesToUse
- the aliases of the certificates in the key store to be used.public static SecurityOptions createJCEKSCertificateOptions(String keystorePath, String keystorePwd, boolean enableSSL, boolean enableStartTLS, int sslPort, Collection<String> aliasesToUse)
keystorePath
- the path of the key store.keystorePwd
- the password of the key store.enableSSL
- whether SSL is enabled or not.enableStartTLS
- whether Start TLS is enabled or not.sslPort
- the value of the LDAPS port.aliasesToUse
- the aliases of the certificates in the keystore to be used.public static SecurityOptions createPKCS11CertificateOptions(String keystorePwd, boolean enableSSL, boolean enableStartTLS, int sslPort, Collection<String> aliasesToUse)
keystorePwd
- the password of the key store.enableSSL
- whether SSL is enabled or not.enableStartTLS
- whether Start TLS is enabled or not.sslPort
- the value of the LDAPS port.aliasesToUse
- the aliases of the certificates in the keystore to be used.public static SecurityOptions createPKCS12CertificateOptions(String keystorePath, String keystorePwd, boolean enableSSL, boolean enableStartTLS, int sslPort, Collection<String> aliasesToUse)
keystorePath
- the path of the key store.keystorePwd
- the password of the key store.enableSSL
- whether SSL is enabled or not.enableStartTLS
- whether Start TLS is enabled or not.sslPort
- the value of the LDAPS port.aliasesToUse
- the aliases of the certificates in the keystore to be used.public static SecurityOptions createOptionsForCertificatType(SecurityOptions.CertificateType certType, String keystorePath, String keystorePwd, boolean enableSSL, boolean enableStartTLS, int sslPort, Collection<String> aliasesToUse)
certType
- The Key Store type.keystorePath
- The path of the key store (may be @null).keystorePwd
- The password of the key store.enableSSL
- Whether SSL is enabled or not.enableStartTLS
- Whether Start TLS is enabled or not.sslPort
- The value of the LDAPS port.aliasesToUse
- The aliases of the certificates in the keystore to be used.public SecurityOptions.CertificateType getCertificateType()
public boolean getEnableSSL()
true
if SSL is enabled and false
otherwise.public boolean getEnableStartTLS()
true
if StartTLS is enabled and false
otherwise.public String getKeystorePassword()
public String getKeystorePath()
public int getSslPort()
public Set<String> getAliasesToUse()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.