org.springframework.boot.web.server

Class Ssl

java.lang.Object

org.springframework.boot.web.server.Ssl

public class Ssl
extends Object

Simple server-independent abstraction for SSL configuration.

Since:

2.0.0

Author:

Andy Wilkinson, Vladimir Tsanev, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ssl.ClientAuth Client authentication types.

Constructor Summary

Constructors

Constructor and Description
Ssl()

Method Summary

Modifier and Type	Method and Description
String[]	getCiphers() Return the supported SSL ciphers.
Ssl.ClientAuth	getClientAuth() Return Whether client authentication is not wanted ("none"), wanted ("want") or needed ("need").
String[]	getEnabledProtocols() Return the enabled SSL protocols.
String	getKeyAlias() Return the alias that identifies the key in the key store.
String	getKeyPassword() Return the password used to access the key in the key store.
String	getKeyStore() Return the path to the key store that holds the SSL certificate (typically a jks file).
String	getKeyStorePassword() Return the password used to access the key store.
String	getKeyStoreProvider() Return the provider for the key store.
String	getKeyStoreType() Return the type of the key store.
String	getProtocol() Return the SSL protocol to use.
String	getTrustStore() Return the trust store that holds SSL certificates.
String	getTrustStorePassword() Return the password used to access the trust store.
String	getTrustStoreProvider() Return the provider for the trust store.
String	getTrustStoreType() Return the type of the trust store.
boolean	isEnabled() Return whether to enable SSL support.
void	setCiphers(String[] ciphers)
void	setClientAuth(Ssl.ClientAuth clientAuth)
void	setEnabled(boolean enabled)
void	setEnabledProtocols(String[] enabledProtocols)
void	setKeyAlias(String keyAlias)
void	setKeyPassword(String keyPassword)
void	setKeyStore(String keyStore)
void	setKeyStorePassword(String keyStorePassword)
void	setKeyStoreProvider(String keyStoreProvider)
void	setKeyStoreType(String keyStoreType)
void	setProtocol(String protocol)
void	setTrustStore(String trustStore)
void	setTrustStorePassword(String trustStorePassword)
void	setTrustStoreProvider(String trustStoreProvider)
void	setTrustStoreType(String trustStoreType)

Methods inherited from class java.lang.Object

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

Constructor Detail

Ssl

public Ssl()

Method Detail

isEnabled

public boolean isEnabled()

Return whether to enable SSL support.

Returns:

whether to enable SSL support

setEnabled

public void setEnabled(boolean enabled)

getClientAuth

public Ssl.ClientAuth getClientAuth()

Return Whether client authentication is not wanted ("none"), wanted ("want") or needed ("need"). Requires a trust store.

Returns:

the Ssl.ClientAuth to use

setClientAuth

public void setClientAuth(Ssl.ClientAuth clientAuth)

getCiphers

public String[] getCiphers()

Return the supported SSL ciphers.

Returns:

the supported SSL ciphers

setCiphers

public void setCiphers(String[] ciphers)

getEnabledProtocols

public String[] getEnabledProtocols()

Return the enabled SSL protocols.

Returns:

the enabled SSL protocols.

setEnabledProtocols

public void setEnabledProtocols(String[] enabledProtocols)

getKeyAlias

public String getKeyAlias()

Return the alias that identifies the key in the key store.

Returns:

the key alias

setKeyAlias

public void setKeyAlias(String keyAlias)

getKeyPassword

public String getKeyPassword()

Return the password used to access the key in the key store.

Returns:

the key password

setKeyPassword

public void setKeyPassword(String keyPassword)

getKeyStore

public String getKeyStore()

Return the path to the key store that holds the SSL certificate (typically a jks file).

Returns:

the path to the key store

setKeyStore

public void setKeyStore(String keyStore)

getKeyStorePassword

public String getKeyStorePassword()

Return the password used to access the key store.

Returns:

the key store password

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

getKeyStoreType

public String getKeyStoreType()

Return the type of the key store.

Returns:

the key store type

setKeyStoreType

public void setKeyStoreType(String keyStoreType)

getKeyStoreProvider

public String getKeyStoreProvider()

Return the provider for the key store.

Returns:

the key store provider

setKeyStoreProvider

public void setKeyStoreProvider(String keyStoreProvider)

getTrustStore

public String getTrustStore()

Return the trust store that holds SSL certificates.

Returns:

the trust store

setTrustStore

public void setTrustStore(String trustStore)

getTrustStorePassword

public String getTrustStorePassword()

Return the password used to access the trust store.

Returns:

the trust store password

setTrustStorePassword

public void setTrustStorePassword(String trustStorePassword)

getTrustStoreType

public String getTrustStoreType()

Return the type of the trust store.

Returns:

the trust store type

setTrustStoreType

public void setTrustStoreType(String trustStoreType)

getTrustStoreProvider

public String getTrustStoreProvider()

Return the provider for the trust store.

Returns:

the trust store provider

setTrustStoreProvider

public void setTrustStoreProvider(String trustStoreProvider)

getProtocol

public String getProtocol()

Return the SSL protocol to use.

Returns:

the SSL protocol

setProtocol

public void setProtocol(String protocol)