Package org.apereo.cas.configuration.model.core.web.tomcat

Class CasEmbeddedApacheSslHostConfigCertificateProperties

java.lang.Object
org.apereo.cas.configuration.model.core.web.tomcat.CasEmbeddedApacheSslHostConfigCertificateProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-webapp-tomcat") public class CasEmbeddedApacheSslHostConfigCertificateProperties extends Object implements Serializable
This is CasEmbeddedApacheSslHostConfigCertificateProperties.
Since:
6.3.0
See Also:

  • Constructor Details

    • CasEmbeddedApacheSslHostConfigCertificateProperties

      public CasEmbeddedApacheSslHostConfigCertificateProperties()

  • Method Details

    • getCertificateFile

      public String getCertificateFile()
      Name of the file that contains the server certificate. The format is PEM-encoded. In addition to the certificate, the file can also contain as optional elements DH parameters and/or an EC curve name for ephemeral keys, as generated by openssl dhparam and openssl ecparam, respectively. The output of the respective OpenSSL command can be concatenated to the certificate file.

    • getCertificateKeyFile

      public String getCertificateKeyFile()
      Name of the file that contains the server private key. The format is PEM-encoded. The default value is the value of certificateFile and in this case both certificate and private key have to be in this file (NOT RECOMMENDED).

    • getCertificateKeyPassword

      public String getCertificateKeyPassword()
      The password used to access the private key associated with the server certificate from the specified file.

    • getCertificateChainFile

      public String getCertificateChainFile()
      Name of the file that contains the certificate chain associated with the server certificate used. The format is PEM-encoded. The certificate chain used for Tomcat should not include the server certificate as its first element. Note that when using more than one certificate for different types, they all must use the same certificate chain.

    • getType

      public String getType()
      The type of certificate. This is used to identify the ciphers that are compatible with the certificate. It must be one of UNDEFINED, RSA, DSS or EC. If only one Certificate is nested within a SSLHostConfig then this attribute is not required and will default to UNDEFINED. If multiple Certificates are nested within a SSLHostConfig then this attribute is required and each Certificate must have a unique type.

    • setCertificateFile

      public CasEmbeddedApacheSslHostConfigCertificateProperties setCertificateFile(String certificateFile)
      Name of the file that contains the server certificate. The format is PEM-encoded. In addition to the certificate, the file can also contain as optional elements DH parameters and/or an EC curve name for ephemeral keys, as generated by openssl dhparam and openssl ecparam, respectively. The output of the respective OpenSSL command can be concatenated to the certificate file.
      Returns:
      this.

    • setCertificateKeyFile

      public CasEmbeddedApacheSslHostConfigCertificateProperties setCertificateKeyFile(String certificateKeyFile)
      Name of the file that contains the server private key. The format is PEM-encoded. The default value is the value of certificateFile and in this case both certificate and private key have to be in this file (NOT RECOMMENDED).
      Returns:
      this.

    • setCertificateKeyPassword

      public CasEmbeddedApacheSslHostConfigCertificateProperties setCertificateKeyPassword(String certificateKeyPassword)
      The password used to access the private key associated with the server certificate from the specified file.
      Returns:
      this.

    • setCertificateChainFile

      public CasEmbeddedApacheSslHostConfigCertificateProperties setCertificateChainFile(String certificateChainFile)
      Name of the file that contains the certificate chain associated with the server certificate used. The format is PEM-encoded. The certificate chain used for Tomcat should not include the server certificate as its first element. Note that when using more than one certificate for different types, they all must use the same certificate chain.
      Returns:
      this.

    • setType

      public CasEmbeddedApacheSslHostConfigCertificateProperties setType(String type)
      The type of certificate. This is used to identify the ciphers that are compatible with the certificate. It must be one of UNDEFINED, RSA, DSS or EC. If only one Certificate is nested within a SSLHostConfig then this attribute is not required and will default to UNDEFINED. If multiple Certificates are nested within a SSLHostConfig then this attribute is required and each Certificate must have a unique type.
      Returns:
      this.