Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Apache CXF API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.cxf.configuration.security
Class TLSClientParametersType

    java.lang.Object
      org.apache.cxf.configuration.security.TLSClientParametersType

Direct Known Subclasses:
  TLSClientParametersConfig.TLSClientParametersTypeInternal

    public class TLSClientParametersType

extends Object

Java class for TLSClientParametersType complex type.

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

     <complexType name="TLSClientParametersType">
       <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="secureRandomParameters" type="{http://cxf.apache.org/configuration/security}SecureRandomParameters" 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="useHttpsURLConnectionDefaultSslSocketFactory" type="{http://cxf.apache.org/configuration/parameterized-types}ParameterizedBoolean" default="false" />
           <attribute name="useHttpsURLConnectionDefaultHostnameVerifier" type="{http://cxf.apache.org/configuration/parameterized-types}ParameterizedBoolean" default="false" />
           <attribute name="disableCNCheck" type="{http://cxf.apache.org/configuration/parameterized-types}ParameterizedBoolean" default="false" />
           <attribute name="jsseProvider" type="{http://www.w3.org/2001/XMLSchema}string" />
           <attribute name="secureSocketProtocol" type="{http://www.w3.org/2001/XMLSchema}string" />
           <attribute name="sslCacheTimeout" type="{http://www.w3.org/2001/XMLSchema}int" />
         </restriction>
       </complexContent>
     </complexType>

Field Summary
`protected String` | `certAlias` This element contains the Certificate Alias.
`protected CertificateConstraintsType` | `certConstraints` This element contains the Certificate Constraints specification.
`protected CipherSuites` | `cipherSuites` This element contains the the CipherSuites that will be supported.
`protected FiltersType` | `cipherSuitesFilter` This element contains the filters of the supported CipherSuites that will be supported and used if available.
`protected Boolean` | `disableCNCheck` This attribute specifies if JSSE should omit checking if the host name specified in the URL matches that of the Common Name (CN) on the server's certificate.
`protected String` | `jsseProvider` This attribute contains the JSSE provider name.
`protected KeyManagersType` | `keyManagers` This element contains the KeyManagers specification.
`protected SecureRandomParameters` | `secureRandomParameters` This element contains SecureRandom specification.
`protected String` | `secureSocketProtocol` This attribute contains the Protocol Name.
`protected Integer` | `sslCacheTimeout` This attribute contains the JDK SSL session cache timeout
`protected TrustManagersType` | `trustManagers` This element contains the TrustManagers specification.
`protected Boolean` | `useHttpsURLConnectionDefaultHostnameVerifier` This attribute specifies if HttpsURLConnection.defaultHostnameVerifier should be used to create https connections.
`protected Boolean` | `useHttpsURLConnectionDefaultSslSocketFactory` This attribute specifies if HttpsURLConnection.defaultSslSocketFactory should be used to create https connections.

Constructor Summary
`TLSClientParametersType()`

Method Summary
`String` | `getCertAlias()` Gets the value of the certAlias property.
`CertificateConstraintsType` | `getCertConstraints()` Gets the value of the certConstraints property.
`CipherSuites` | `getCipherSuites()` Gets the value of the cipherSuites property.
`FiltersType` | `getCipherSuitesFilter()` Gets the value of the cipherSuitesFilter property.
`String` | `getJsseProvider()` Gets the value of the jsseProvider property.
`KeyManagersType` | `getKeyManagers()` Gets the value of the keyManagers property.
`SecureRandomParameters` | `getSecureRandomParameters()` Gets the value of the secureRandomParameters property.
`String` | `getSecureSocketProtocol()` Gets the value of the secureSocketProtocol property.
`int` | `getSslCacheTimeout()` Gets the value of the sslCacheTimeout property.
`TrustManagersType` | `getTrustManagers()` Gets the value of the trustManagers property.
`boolean` | `isDisableCNCheck()` Gets the value of the disableCNCheck property.
`boolean` | `isSetCertAlias()`
`boolean` | `isSetCertConstraints()`
`boolean` | `isSetCipherSuites()`
`boolean` | `isSetCipherSuitesFilter()`
`boolean` | `isSetDisableCNCheck()`
`boolean` | `isSetJsseProvider()`
`boolean` | `isSetKeyManagers()`
`boolean` | `isSetSecureRandomParameters()`
`boolean` | `isSetSecureSocketProtocol()`
`boolean` | `isSetSslCacheTimeout()`
`boolean` | `isSetTrustManagers()`
`boolean` | `isSetUseHttpsURLConnectionDefaultHostnameVerifier()`
`boolean` | `isSetUseHttpsURLConnectionDefaultSslSocketFactory()`
`boolean` | `isUseHttpsURLConnectionDefaultHostnameVerifier()` Gets the value of the useHttpsURLConnectionDefaultHostnameVerifier property.
`boolean` | `isUseHttpsURLConnectionDefaultSslSocketFactory()` Gets the value of the useHttpsURLConnectionDefaultSslSocketFactory property.
`void` | `setCertAlias(String value)` Sets the value of the certAlias property.
`void` | `setCertConstraints(CertificateConstraintsType value)` Sets the value of the certConstraints property.
`void` | `setCipherSuites(CipherSuites value)` Sets the value of the cipherSuites property.
`void` | `setCipherSuitesFilter(FiltersType value)` Sets the value of the cipherSuitesFilter property.
`void` | `setDisableCNCheck(boolean value)` Sets the value of the disableCNCheck property.
`void` | `setJsseProvider(String value)` Sets the value of the jsseProvider property.
`void` | `setKeyManagers(KeyManagersType value)` Sets the value of the keyManagers property.
`void` | `setSecureRandomParameters(SecureRandomParameters value)` Sets the value of the secureRandomParameters property.
`void` | `setSecureSocketProtocol(String value)` Sets the value of the secureSocketProtocol property.
`void` | `setSslCacheTimeout(int value)` Sets the value of the sslCacheTimeout property.
`void` | `setTrustManagers(TrustManagersType value)` Sets the value of the trustManagers property.
`void` | `setUseHttpsURLConnectionDefaultHostnameVerifier(boolean value)` Sets the value of the useHttpsURLConnectionDefaultHostnameVerifier property.
`void` | `setUseHttpsURLConnectionDefaultSslSocketFactory(boolean value)` Sets the value of the useHttpsURLConnectionDefaultSslSocketFactory property.
`void` | `unsetDisableCNCheck()`
`void` | `unsetSslCacheTimeout()`
`void` | `unsetUseHttpsURLConnectionDefaultHostnameVerifier()`
`void` | `unsetUseHttpsURLConnectionDefaultSslSocketFactory()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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.

### secureRandomParameters

    protected SecureRandomParameters secureRandomParameters

  This element contains SecureRandom specification.

### certConstraints

    protected CertificateConstraintsType certConstraints

  This element contains the Certificate Constraints specification.

### certAlias

    protected String certAlias

  This element contains the Certificate Alias.

### useHttpsURLConnectionDefaultSslSocketFactory

    protected Boolean useHttpsURLConnectionDefaultSslSocketFactory

  This attribute specifies if HttpsURLConnection.defaultSslSocketFactory should be used to create https connections. If 'true', 'jsseProvider', 'secureSocketProtocol', 'trustManagers', 'keyManagers', 'secureRandom', 'cipherSuites' and 'cipherSuitesFilter' are ignored. Since 2.2.7.

### useHttpsURLConnectionDefaultHostnameVerifier

    protected Boolean useHttpsURLConnectionDefaultHostnameVerifier

  This attribute specifies if HttpsURLConnection.defaultHostnameVerifier should be used to create https connections. If 'true', 'disableCNCheck' is ignored. Since 2.2.7.

### disableCNCheck

    protected Boolean disableCNCheck

  This attribute specifies if JSSE should omit checking if the host name specified in the URL matches that of the Common Name (CN) on the server's certificate. Default is false; this attribute should not be set to true during production use.

### 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".

### sslCacheTimeout

    protected Integer sslCacheTimeout

  This attribute contains the JDK SSL session cache timeout

Constructor Detail

### TLSClientParametersType

    public TLSClientParametersType()

Method Detail

### getKeyManagers

    public KeyManagersType getKeyManagers()

  Gets the value of the keyManagers property.

  This element contains the KeyManagers specification.

  Returns:
    possible object is `KeyManagersType`

### setKeyManagers

    public void setKeyManagers(KeyManagersType value)

  Sets the value of the keyManagers property.

  Parameters:
    `value` - allowed object is `KeyManagersType`
  See Also:
    `getKeyManagers()`

### 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`

### setTrustManagers

    public void setTrustManagers(TrustManagersType value)

  Sets the value of the trustManagers property.

  Parameters:
    `value` - allowed object is `TrustManagersType`
  See Also:
    `getTrustManagers()`

### 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`

### setCipherSuites

    public void setCipherSuites(CipherSuites value)

  Sets the value of the cipherSuites property.

  Parameters:
    `value` - allowed object is `CipherSuites`
  See Also:
    `getCipherSuites()`

### 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`

### setCipherSuitesFilter

    public void setCipherSuitesFilter(FiltersType value)

  Sets the value of the cipherSuitesFilter property.

  Parameters:
    `value` - allowed object is `FiltersType`
  See Also:
    `getCipherSuitesFilter()`

### isSetCipherSuitesFilter

    public boolean isSetCipherSuitesFilter()

### getSecureRandomParameters

    public SecureRandomParameters getSecureRandomParameters()

  Gets the value of the secureRandomParameters property.

  This element contains SecureRandom specification.

  Returns:
    possible object is `SecureRandomParameters`

### setSecureRandomParameters

    public void setSecureRandomParameters(SecureRandomParameters value)

  Sets the value of the secureRandomParameters property.

  Parameters:
    `value` - allowed object is `SecureRandomParameters`
  See Also:
    `getSecureRandomParameters()`

### isSetSecureRandomParameters

    public boolean isSetSecureRandomParameters()

### getCertConstraints

    public CertificateConstraintsType getCertConstraints()

  Gets the value of the certConstraints property.

  This element contains the Certificate Constraints specification.

  Returns:
    possible object is `CertificateConstraintsType`

### setCertConstraints

    public void setCertConstraints(CertificateConstraintsType value)

  Sets the value of the certConstraints property.

  Parameters:
    `value` - allowed object is `CertificateConstraintsType`
  See Also:
    `getCertConstraints()`

### 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()

### getSslCacheTimeout

    public int getSslCacheTimeout()

  Gets the value of the sslCacheTimeout property.

  This attribute contains the JDK SSL session cache timeout

  Returns:
    possible object is `Integer`

### setSslCacheTimeout

    public void setSslCacheTimeout(int value)

  Sets the value of the sslCacheTimeout property.

  Parameters:
    `value` - allowed object is `Integer`
  See Also:
    `getSslCacheTimeout()`

### isSetSslCacheTimeout

    public boolean isSetSslCacheTimeout()

### unsetSslCacheTimeout

    public void unsetSslCacheTimeout()

### setUseHttpsURLConnectionDefaultSslSocketFactory

    public void setUseHttpsURLConnectionDefaultSslSocketFactory(boolean value)

  Sets the value of the useHttpsURLConnectionDefaultSslSocketFactory property.

  See Also:
    `isUseHttpsURLConnectionDefaultSslSocketFactory()`

### unsetUseHttpsURLConnectionDefaultSslSocketFactory

    public void unsetUseHttpsURLConnectionDefaultSslSocketFactory()

### isSetUseHttpsURLConnectionDefaultSslSocketFactory

    public boolean isSetUseHttpsURLConnectionDefaultSslSocketFactory()

### isUseHttpsURLConnectionDefaultSslSocketFactory

    public boolean isUseHttpsURLConnectionDefaultSslSocketFactory()

  Gets the value of the useHttpsURLConnectionDefaultSslSocketFactory property.

  This attribute specifies if HttpsURLConnection.defaultSslSocketFactory should be used to create https connections. If 'true', 'jsseProvider', 'secureSocketProtocol', 'trustManagers', 'keyManagers', 'secureRandom', 'cipherSuites' and 'cipherSuitesFilter' are ignored. Since 2.2.7.

### setUseHttpsURLConnectionDefaultHostnameVerifier

    public void setUseHttpsURLConnectionDefaultHostnameVerifier(boolean value)

  Sets the value of the useHttpsURLConnectionDefaultHostnameVerifier property.

  See Also:
    `isUseHttpsURLConnectionDefaultHostnameVerifier()`

### unsetUseHttpsURLConnectionDefaultHostnameVerifier

    public void unsetUseHttpsURLConnectionDefaultHostnameVerifier()

### isSetUseHttpsURLConnectionDefaultHostnameVerifier

    public boolean isSetUseHttpsURLConnectionDefaultHostnameVerifier()

### isUseHttpsURLConnectionDefaultHostnameVerifier

    public boolean isUseHttpsURLConnectionDefaultHostnameVerifier()

  Gets the value of the useHttpsURLConnectionDefaultHostnameVerifier property.

  This attribute specifies if HttpsURLConnection.defaultHostnameVerifier should be used to create https connections. If 'true', 'disableCNCheck' is ignored. Since 2.2.7.

### setDisableCNCheck

    public void setDisableCNCheck(boolean value)

  Sets the value of the disableCNCheck property.

  See Also:
    `isDisableCNCheck()`

### unsetDisableCNCheck

    public void unsetDisableCNCheck()

### isSetDisableCNCheck

    public boolean isSetDisableCNCheck()

### isDisableCNCheck

    public boolean isDisableCNCheck()

  Gets the value of the disableCNCheck property.

  This attribute specifies if JSSE should omit checking if the host name specified in the URL matches that of the Common Name (CN) on the server's certificate. Default is false; this attribute should not be set to true during production use.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Apache CXF API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Apache CXF