Package org.apache.cxf.configuration.security

Class TLSServerParametersType

  • Direct Known Subclasses:
    TLSServerParametersConfig.TLSServerParametersTypeInternal
    public class TLSServerParametersType
extends Object

    Java class for TLSServerParametersType complex type.

    The following schema fragment specifies the expected content contained within this class. 

     <complexType name="TLSServerParametersType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="keyManagers" type="{http://cxf.apache.org/configuration/security}KeyManagersType" minOccurs="0"/>
         <element name="trustManagers" type="{http://cxf.apache.org/configuration/security}TrustManagersType" minOccurs="0"/>
         <element name="cipherSuites" type="{http://cxf.apache.org/configuration/security}CipherSuites" minOccurs="0"/>
         <element name="cipherSuitesFilter" type="{http://cxf.apache.org/configuration/security}FiltersType" minOccurs="0"/>
         <element name="excludeProtocols" type="{http://cxf.apache.org/configuration/security}ExcludeProtocols" minOccurs="0"/>
         <element name="includeProtocols" type="{http://cxf.apache.org/configuration/security}IncludeProtocols" minOccurs="0"/>
         <element name="secureRandomParameters" type="{http://cxf.apache.org/configuration/security}SecureRandomParameters" minOccurs="0"/>
         <element name="clientAuthentication" type="{http://cxf.apache.org/configuration/security}ClientAuthentication" minOccurs="0"/>
         <element name="certConstraints" type="{http://cxf.apache.org/configuration/security}CertificateConstraintsType" minOccurs="0"/>
         <element name="certAlias" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </all>
       <attribute name="jsseProvider" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="secureSocketProtocol" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="enableRevocation" type="{http://cxf.apache.org/configuration/parameterized-types}ParameterizedBoolean" default="false" />
       <attribute name="sniHostCheck" type="{http://cxf.apache.org/configuration/parameterized-types}ParameterizedBoolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • keyManagers

        protected KeyManagersType keyManagers
        This element contains the KeyManagers specification.

      • trustManagers

        protected TrustManagersType trustManagers
        This element contains the TrustManagers specification.

      • cipherSuites

        protected CipherSuites cipherSuites
        This element contains the the CipherSuites that will be supported.

      • cipherSuitesFilter

        protected FiltersType cipherSuitesFilter
        This element contains the filters of the supported CipherSuites that will be supported and used if available.

      • excludeProtocols

        protected ExcludeProtocols excludeProtocols
        This element contains the the Protocols that will be excluded

      • includeProtocols

        protected IncludeProtocols includeProtocols
        This element contains the the Protocols that will be included

      • secureRandomParameters

        protected SecureRandomParameters secureRandomParameters
        This element contains SecureRandom specification.

      • clientAuthentication

        protected ClientAuthentication clientAuthentication
        This element contains Client Authentication specification.

      • certConstraints

        protected CertificateConstraintsType certConstraints
        This element contains the Certificate Constraints specification.

      • certAlias

        protected String certAlias
        This element contains the Certificate Alias.

      • jsseProvider

        protected String jsseProvider
        This attribute contains the JSSE provider name.

      • secureSocketProtocol

        protected String secureSocketProtocol
        This attribute contains the Protocol Name. Most common example is "SSL", "TLS" or "TLSv1".

      • enableRevocation

        protected Boolean enableRevocation
        This attribute specifies whether to enable revocation when checking the client certificate, if client authentication is enabled. The default is false.

      • sniHostCheck

        protected Boolean sniHostCheck
        If the SNI host name must match.

    • Constructor Detail

      • TLSServerParametersType

        public TLSServerParametersType()

    • Method Detail

      • getKeyManagers

        public KeyManagersType getKeyManagers()
        Gets the value of the keyManagers property.

        This element contains the KeyManagers specification.

        Returns:
        possible object is KeyManagersType

      • isSetKeyManagers

        public boolean isSetKeyManagers()

      • getTrustManagers

        public TrustManagersType getTrustManagers()
        Gets the value of the trustManagers property.

        This element contains the TrustManagers specification.

        Returns:
        possible object is TrustManagersType

      • isSetTrustManagers

        public boolean isSetTrustManagers()

      • getCipherSuites

        public CipherSuites getCipherSuites()
        Gets the value of the cipherSuites property.

        This element contains the the CipherSuites that will be supported.

        Returns:
        possible object is CipherSuites

      • isSetCipherSuites

        public boolean isSetCipherSuites()

      • getCipherSuitesFilter

        public FiltersType getCipherSuitesFilter()
        Gets the value of the cipherSuitesFilter property.

        This element contains the filters of the supported CipherSuites that will be supported and used if available.

        Returns:
        possible object is FiltersType

      • isSetCipherSuitesFilter

        public boolean isSetCipherSuitesFilter()

      • getExcludeProtocols

        public ExcludeProtocols getExcludeProtocols()
        Gets the value of the excludeProtocols property.

        This element contains the the Protocols that will be excluded

        Returns:
        possible object is ExcludeProtocols

      • isSetExcludeProtocols

        public boolean isSetExcludeProtocols()

      • getIncludeProtocols

        public IncludeProtocols getIncludeProtocols()
        Gets the value of the includeProtocols property.

        This element contains the the Protocols that will be included

        Returns:
        possible object is IncludeProtocols

      • isSetIncludeProtocols

        public boolean isSetIncludeProtocols()

      • getSecureRandomParameters

        public SecureRandomParameters getSecureRandomParameters()
        Gets the value of the secureRandomParameters property.

        This element contains SecureRandom specification.

        Returns:
        possible object is SecureRandomParameters

      • isSetSecureRandomParameters

        public boolean isSetSecureRandomParameters()

      • getClientAuthentication

        public ClientAuthentication getClientAuthentication()
        Gets the value of the clientAuthentication property.

        This element contains Client Authentication specification.

        Returns:
        possible object is ClientAuthentication

      • isSetClientAuthentication

        public boolean isSetClientAuthentication()

      • isSetCertConstraints

        public boolean isSetCertConstraints()

      • getCertAlias

        public String getCertAlias()
        Gets the value of the certAlias property.

        This element contains the Certificate Alias.

        Returns:
        possible object is String

      • setCertAlias

        public void setCertAlias​(String value)
        Sets the value of the certAlias property.
        Parameters:
        value - allowed object is String
        See Also:
        getCertAlias()

      • isSetCertAlias

        public boolean isSetCertAlias()

      • getJsseProvider

        public String getJsseProvider()
        Gets the value of the jsseProvider property.

        This attribute contains the JSSE provider name.

        Returns:
        possible object is String

      • setJsseProvider

        public void setJsseProvider​(String value)
        Sets the value of the jsseProvider property.
        Parameters:
        value - allowed object is String
        See Also:
        getJsseProvider()

      • isSetJsseProvider

        public boolean isSetJsseProvider()

      • getSecureSocketProtocol

        public String getSecureSocketProtocol()
        Gets the value of the secureSocketProtocol property.

        This attribute contains the Protocol Name. Most common example is "SSL", "TLS" or "TLSv1".

        Returns:
        possible object is String

      • setSecureSocketProtocol

        public void setSecureSocketProtocol​(String value)
        Sets the value of the secureSocketProtocol property.
        Parameters:
        value - allowed object is String
        See Also:
        getSecureSocketProtocol()

      • isSetSecureSocketProtocol

        public boolean isSetSecureSocketProtocol()

      • setEnableRevocation

        public void setEnableRevocation​(boolean value)
        Sets the value of the enableRevocation property.
        See Also:
        isEnableRevocation()

      • unsetEnableRevocation

        public void unsetEnableRevocation()

      • isSetEnableRevocation

        public boolean isSetEnableRevocation()

      • isEnableRevocation

        public boolean isEnableRevocation()
        Gets the value of the enableRevocation property.

        This attribute specifies whether to enable revocation when checking the client certificate, if client authentication is enabled. The default is false.

      • setSniHostCheck

        public void setSniHostCheck​(boolean value)
        Sets the value of the sniHostCheck property.
        See Also:
        isSniHostCheck()

      • unsetSniHostCheck

        public void unsetSniHostCheck()

      • isSetSniHostCheck

        public boolean isSetSniHostCheck()

      • isSniHostCheck

        public boolean isSniHostCheck()
        Gets the value of the sniHostCheck property.

        If the SNI host name must match.