Apache CXF API

org.apache.cxf.configuration.security
Class SSLClientPolicy

java.lang.Object
  extended by org.apache.cxf.configuration.security.SSLClientPolicy

public class SSLClientPolicy
extends java.lang.Object

New policies for controlling SSL encryption

Java class for SSLClientPolicy complex type.

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

 <complexType name="SSLClientPolicy">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Keystore" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="KeystoreType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="KeystorePassword" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="KeyPassword" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="KeystoreAlgorithm" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Ciphersuites" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="CiphersuiteFilters" type="{http://cxf.apache.org/configuration/security}FiltersType" minOccurs="0"/>
         <element name="TrustStore" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TrustStoreType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TrustStoreAlgorithm" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SecureSocketProtocol" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SessionCaching" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="SessionCacheKey" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="MaxChainLength" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="CertValidator" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ProxyHost" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ProxyPort" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  java.lang.String certValidator
           
protected  FiltersType ciphersuiteFilters
           
protected  java.util.List<java.lang.String> ciphersuites
           
protected  java.lang.String keyPassword
           
protected  java.lang.String keystore
           
protected  java.lang.String keystoreAlgorithm
           
protected  java.lang.String keystorePassword
           
protected  java.lang.String keystoreType
           
protected  java.lang.Long maxChainLength
           
protected  java.lang.String proxyHost
           
protected  java.lang.Long proxyPort
           
protected  java.lang.String secureSocketProtocol
           
protected  java.lang.String sessionCacheKey
           
protected  java.lang.Boolean sessionCaching
           
protected  java.lang.String trustStore
           
protected  java.lang.String trustStoreAlgorithm
           
protected  java.lang.String trustStoreType
           
 
Constructor Summary
SSLClientPolicy()
           
 
Method Summary
 java.lang.String getCertValidator()
          Gets the value of the certValidator property.
 FiltersType getCiphersuiteFilters()
          Gets the value of the ciphersuiteFilters property.
 java.util.List<java.lang.String> getCiphersuites()
          Gets the value of the ciphersuites property.
 java.lang.String getKeyPassword()
          Gets the value of the keyPassword property.
 java.lang.String getKeystore()
          Gets the value of the keystore property.
 java.lang.String getKeystoreAlgorithm()
          Gets the value of the keystoreAlgorithm property.
 java.lang.String getKeystorePassword()
          Gets the value of the keystorePassword property.
 java.lang.String getKeystoreType()
          Gets the value of the keystoreType property.
 java.lang.Long getMaxChainLength()
          Gets the value of the maxChainLength property.
 java.lang.String getProxyHost()
          Gets the value of the proxyHost property.
 java.lang.Long getProxyPort()
          Gets the value of the proxyPort property.
 java.lang.String getSecureSocketProtocol()
          Gets the value of the secureSocketProtocol property.
 java.lang.String getSessionCacheKey()
          Gets the value of the sessionCacheKey property.
 java.lang.String getTrustStore()
          Gets the value of the trustStore property.
 java.lang.String getTrustStoreAlgorithm()
          Gets the value of the trustStoreAlgorithm property.
 java.lang.String getTrustStoreType()
          Gets the value of the trustStoreType property.
 java.lang.Boolean isSessionCaching()
          Gets the value of the sessionCaching property.
 boolean isSetCertValidator()
           
 boolean isSetCiphersuiteFilters()
           
 boolean isSetCiphersuites()
           
 boolean isSetKeyPassword()
           
 boolean isSetKeystore()
           
 boolean isSetKeystoreAlgorithm()
           
 boolean isSetKeystorePassword()
           
 boolean isSetKeystoreType()
           
 boolean isSetMaxChainLength()
           
 boolean isSetProxyHost()
           
 boolean isSetProxyPort()
           
 boolean isSetSecureSocketProtocol()
           
 boolean isSetSessionCacheKey()
           
 boolean isSetSessionCaching()
           
 boolean isSetTrustStore()
           
 boolean isSetTrustStoreAlgorithm()
           
 boolean isSetTrustStoreType()
           
 void setCertValidator(java.lang.String value)
          Sets the value of the certValidator property.
 void setCiphersuiteFilters(FiltersType value)
          Sets the value of the ciphersuiteFilters property.
 void setKeyPassword(java.lang.String value)
          Sets the value of the keyPassword property.
 void setKeystore(java.lang.String value)
          Sets the value of the keystore property.
 void setKeystoreAlgorithm(java.lang.String value)
          Sets the value of the keystoreAlgorithm property.
 void setKeystorePassword(java.lang.String value)
          Sets the value of the keystorePassword property.
 void setKeystoreType(java.lang.String value)
          Sets the value of the keystoreType property.
 void setMaxChainLength(java.lang.Long value)
          Sets the value of the maxChainLength property.
 void setProxyHost(java.lang.String value)
          Sets the value of the proxyHost property.
 void setProxyPort(java.lang.Long value)
          Sets the value of the proxyPort property.
 void setSecureSocketProtocol(java.lang.String value)
          Sets the value of the secureSocketProtocol property.
 void setSessionCacheKey(java.lang.String value)
          Sets the value of the sessionCacheKey property.
 void setSessionCaching(java.lang.Boolean value)
          Sets the value of the sessionCaching property.
 void setTrustStore(java.lang.String value)
          Sets the value of the trustStore property.
 void setTrustStoreAlgorithm(java.lang.String value)
          Sets the value of the trustStoreAlgorithm property.
 void setTrustStoreType(java.lang.String value)
          Sets the value of the trustStoreType property.
 void unsetCiphersuites()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

keystore

protected java.lang.String keystore

keystoreType

protected java.lang.String keystoreType

keystorePassword

protected java.lang.String keystorePassword

keyPassword

protected java.lang.String keyPassword

keystoreAlgorithm

protected java.lang.String keystoreAlgorithm

ciphersuites

protected java.util.List<java.lang.String> ciphersuites

ciphersuiteFilters

protected FiltersType ciphersuiteFilters

trustStore

protected java.lang.String trustStore

trustStoreType

protected java.lang.String trustStoreType

trustStoreAlgorithm

protected java.lang.String trustStoreAlgorithm

secureSocketProtocol

protected java.lang.String secureSocketProtocol

sessionCaching

protected java.lang.Boolean sessionCaching

sessionCacheKey

protected java.lang.String sessionCacheKey

maxChainLength

protected java.lang.Long maxChainLength

certValidator

protected java.lang.String certValidator

proxyHost

protected java.lang.String proxyHost

proxyPort

protected java.lang.Long proxyPort
Constructor Detail

SSLClientPolicy

public SSLClientPolicy()
Method Detail

getKeystore

public java.lang.String getKeystore()
Gets the value of the keystore property.

Returns:
possible object is String

setKeystore

public void setKeystore(java.lang.String value)
Sets the value of the keystore property.

Parameters:
value - allowed object is String

isSetKeystore

public boolean isSetKeystore()

getKeystoreType

public java.lang.String getKeystoreType()
Gets the value of the keystoreType property.

Returns:
possible object is String

setKeystoreType

public void setKeystoreType(java.lang.String value)
Sets the value of the keystoreType property.

Parameters:
value - allowed object is String

isSetKeystoreType

public boolean isSetKeystoreType()

getKeystorePassword

public java.lang.String getKeystorePassword()
Gets the value of the keystorePassword property.

Returns:
possible object is String

setKeystorePassword

public void setKeystorePassword(java.lang.String value)
Sets the value of the keystorePassword property.

Parameters:
value - allowed object is String

isSetKeystorePassword

public boolean isSetKeystorePassword()

getKeyPassword

public java.lang.String getKeyPassword()
Gets the value of the keyPassword property.

Returns:
possible object is String

setKeyPassword

public void setKeyPassword(java.lang.String value)
Sets the value of the keyPassword property.

Parameters:
value - allowed object is String

isSetKeyPassword

public boolean isSetKeyPassword()

getKeystoreAlgorithm

public java.lang.String getKeystoreAlgorithm()
Gets the value of the keystoreAlgorithm property.

Returns:
possible object is String

setKeystoreAlgorithm

public void setKeystoreAlgorithm(java.lang.String value)
Sets the value of the keystoreAlgorithm property.

Parameters:
value - allowed object is String

isSetKeystoreAlgorithm

public boolean isSetKeystoreAlgorithm()

getCiphersuites

public java.util.List<java.lang.String> getCiphersuites()
Gets the value of the ciphersuites property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the ciphersuites property.

For example, to add a new item, do as follows:

    getCiphersuites().add(newItem);
 

Objects of the following type(s) are allowed in the list String


isSetCiphersuites

public boolean isSetCiphersuites()

unsetCiphersuites

public void unsetCiphersuites()

getCiphersuiteFilters

public FiltersType getCiphersuiteFilters()
Gets the value of the ciphersuiteFilters property.

Returns:
possible object is FiltersType

setCiphersuiteFilters

public void setCiphersuiteFilters(FiltersType value)
Sets the value of the ciphersuiteFilters property.

Parameters:
value - allowed object is FiltersType

isSetCiphersuiteFilters

public boolean isSetCiphersuiteFilters()

getTrustStore

public java.lang.String getTrustStore()
Gets the value of the trustStore property.

Returns:
possible object is String

setTrustStore

public void setTrustStore(java.lang.String value)
Sets the value of the trustStore property.

Parameters:
value - allowed object is String

isSetTrustStore

public boolean isSetTrustStore()

getTrustStoreType

public java.lang.String getTrustStoreType()
Gets the value of the trustStoreType property.

Returns:
possible object is String

setTrustStoreType

public void setTrustStoreType(java.lang.String value)
Sets the value of the trustStoreType property.

Parameters:
value - allowed object is String

isSetTrustStoreType

public boolean isSetTrustStoreType()

getTrustStoreAlgorithm

public java.lang.String getTrustStoreAlgorithm()
Gets the value of the trustStoreAlgorithm property.

Returns:
possible object is String

setTrustStoreAlgorithm

public void setTrustStoreAlgorithm(java.lang.String value)
Sets the value of the trustStoreAlgorithm property.

Parameters:
value - allowed object is String

isSetTrustStoreAlgorithm

public boolean isSetTrustStoreAlgorithm()

getSecureSocketProtocol

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

Returns:
possible object is String

setSecureSocketProtocol

public void setSecureSocketProtocol(java.lang.String value)
Sets the value of the secureSocketProtocol property.

Parameters:
value - allowed object is String

isSetSecureSocketProtocol

public boolean isSetSecureSocketProtocol()

isSessionCaching

public java.lang.Boolean isSessionCaching()
Gets the value of the sessionCaching property.

Returns:
possible object is Boolean

setSessionCaching

public void setSessionCaching(java.lang.Boolean value)
Sets the value of the sessionCaching property.

Parameters:
value - allowed object is Boolean

isSetSessionCaching

public boolean isSetSessionCaching()

getSessionCacheKey

public java.lang.String getSessionCacheKey()
Gets the value of the sessionCacheKey property.

Returns:
possible object is String

setSessionCacheKey

public void setSessionCacheKey(java.lang.String value)
Sets the value of the sessionCacheKey property.

Parameters:
value - allowed object is String

isSetSessionCacheKey

public boolean isSetSessionCacheKey()

getMaxChainLength

public java.lang.Long getMaxChainLength()
Gets the value of the maxChainLength property.

Returns:
possible object is Long

setMaxChainLength

public void setMaxChainLength(java.lang.Long value)
Sets the value of the maxChainLength property.

Parameters:
value - allowed object is Long

isSetMaxChainLength

public boolean isSetMaxChainLength()

getCertValidator

public java.lang.String getCertValidator()
Gets the value of the certValidator property.

Returns:
possible object is String

setCertValidator

public void setCertValidator(java.lang.String value)
Sets the value of the certValidator property.

Parameters:
value - allowed object is String

isSetCertValidator

public boolean isSetCertValidator()

getProxyHost

public java.lang.String getProxyHost()
Gets the value of the proxyHost property.

Returns:
possible object is String

setProxyHost

public void setProxyHost(java.lang.String value)
Sets the value of the proxyHost property.

Parameters:
value - allowed object is String

isSetProxyHost

public boolean isSetProxyHost()

getProxyPort

public java.lang.Long getProxyPort()
Gets the value of the proxyPort property.

Returns:
possible object is Long

setProxyPort

public void setProxyPort(java.lang.Long value)
Sets the value of the proxyPort property.

Parameters:
value - allowed object is Long

isSetProxyPort

public boolean isSetProxyPort()

Apache CXF API

-