org.springframework.boot.web.server

Class Ssl

  • java.lang.Object
    • org.springframework.boot.web.server.Ssl

  • public class Ssl
extends java.lang.Object
    Simple server-independent abstraction for SSL configuration.
    Since:
    2.0.0

    • 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 java.lang.String[] getCiphers()
        Return the supported SSL ciphers.
        Returns:
        the supported SSL ciphers

      • setCiphers

        public void setCiphers(java.lang.String[] ciphers)

      • getEnabledProtocols

        public java.lang.String[] getEnabledProtocols()
        Return the enabled SSL protocols.
        Returns:
        the enabled SSL protocols.

      • setEnabledProtocols

        public void setEnabledProtocols(java.lang.String[] enabledProtocols)

      • getKeyAlias

        public java.lang.String getKeyAlias()
        Return the alias that identifies the key in the key store.
        Returns:
        the key alias

      • setKeyAlias

        public void setKeyAlias(java.lang.String keyAlias)

      • getKeyPassword

        public java.lang.String getKeyPassword()
        Return the password used to access the key in the key store.
        Returns:
        the key password

      • setKeyPassword

        public void setKeyPassword(java.lang.String keyPassword)

      • getKeyStore

        public java.lang.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(java.lang.String keyStore)

      • getKeyStorePassword

        public java.lang.String getKeyStorePassword()
        Return the password used to access the key store.
        Returns:
        the key store password

      • setKeyStorePassword

        public void setKeyStorePassword(java.lang.String keyStorePassword)

      • getKeyStoreType

        public java.lang.String getKeyStoreType()
        Return the type of the key store.
        Returns:
        the key store type

      • setKeyStoreType

        public void setKeyStoreType(java.lang.String keyStoreType)

      • getKeyStoreProvider

        public java.lang.String getKeyStoreProvider()
        Return the provider for the key store.
        Returns:
        the key store provider

      • setKeyStoreProvider

        public void setKeyStoreProvider(java.lang.String keyStoreProvider)

      • getTrustStore

        public java.lang.String getTrustStore()
        Return the trust store that holds SSL certificates.
        Returns:
        the trust store

      • setTrustStore

        public void setTrustStore(java.lang.String trustStore)

      • getTrustStorePassword

        public java.lang.String getTrustStorePassword()
        Return the password used to access the trust store.
        Returns:
        the trust store password

      • setTrustStorePassword

        public void setTrustStorePassword(java.lang.String trustStorePassword)

      • getTrustStoreType

        public java.lang.String getTrustStoreType()
        Return the type of the trust store.
        Returns:
        the trust store type

      • setTrustStoreType

        public void setTrustStoreType(java.lang.String trustStoreType)

      • getTrustStoreProvider

        public java.lang.String getTrustStoreProvider()
        Return the provider for the trust store.
        Returns:
        the trust store provider

      • setTrustStoreProvider

        public void setTrustStoreProvider(java.lang.String trustStoreProvider)

      • getCertificate

        public java.lang.String getCertificate()
        Return the location of the certificate in PEM format.
        Returns:
        the certificate location

      • setCertificate

        public void setCertificate(java.lang.String certificate)

      • getCertificatePrivateKey

        public java.lang.String getCertificatePrivateKey()
        Return the location of the private key for the certificate in PEM format.
        Returns:
        the location of the certificate private key

      • setCertificatePrivateKey

        public void setCertificatePrivateKey(java.lang.String certificatePrivateKey)

      • getTrustCertificate

        public java.lang.String getTrustCertificate()
        Return the location of the trust certificate authority chain in PEM format.
        Returns:
        the location of the trust certificate

      • setTrustCertificate

        public void setTrustCertificate(java.lang.String trustCertificate)

      • getTrustCertificatePrivateKey

        public java.lang.String getTrustCertificatePrivateKey()
        Return the location of the private key for the trust certificate in PEM format.
        Returns:
        the location of the trust certificate private key

      • setTrustCertificatePrivateKey

        public void setTrustCertificatePrivateKey(java.lang.String trustCertificatePrivateKey)

      • getProtocol

        public java.lang.String getProtocol()
        Return the SSL protocol to use.
        Returns:
        the SSL protocol

      • setProtocol

        public void setProtocol(java.lang.String protocol)