|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.transport.client.EPPSSLConfig
public class EPPSSLConfig
The EPPSSLConfig
class contains SSL configuration properties
that can be used in conjunction with EPPSSLImpl.initialize(EPPSSLConfig)
to initialize an EPPSSLContext
. The required properties include:
sslProtocol
that defines the SSL protocol to use. For example,
"TLS".
identityStoreType
that defines the type of the identity KeyStore.
For example, "JKS".
identityFileName
that defines the name of the identity KeyStore file.
For example, "identity.jks".
identityPassPhrase
that defines the passphrase/password to access
the identity KeyStore file defined by the identityFileName
property.
identityKeyPassPhrase
that defines the passphrase/password for the
private key stored in the identity KeyStore. If not defined, the value of the
identityPassPhrase
will be used.
trustStoreType
that defines the KeyStore type of the Trust Store.
This is only required if the Trust Store is defined by the trustStoreFileName
property. For example, "JKS".
trustStoreFileName
that defines the name of the Trust Store file.
For example, "trust.jks". If note defined, the default JDK Trust Store
will be used that is located at the path $JAVA_HOME/lib/security/cacerts
.
trustStorePassPhrase
that defines the passphrase/password to access
the identity KeyStore file defined by the trustStoreFileName
property.
This is only required if the Trust Store is defined by the trustStoreFileName
property.
sslDebug
that defines that value of the SSL debug Java system property
javax.net.debug
. If not set, than the javax.net.debug
system property will not set. The possible values include "none" and
"all" and since it sets a Java system property it will global apply across all
SSL connections om the Java process.
sslEnabledProtocols
that defines the support SSL protocols supported.
If not defined, the default protocols provided by the JSSE provider will be used.
For example, {"TLSv1", "SSLv3"}.
sslEnabledCipherSuites
that defines the support SSL cipher suites supported.
If not defined, the default cipher suites provided by the JSSE provider will be used.
For example, SSL_RSA_WITH_RC4_128_MD5 SSL_RSA_WITH_RC4_128_SHA
.
EPPSSLImpl
,
EPPSSLContext
Constructor Summary | |
---|---|
EPPSSLConfig()
Default constructor. |
|
EPPSSLConfig(java.lang.String aSslProtocol,
java.lang.String aIdentityStoreType,
java.lang.String aIdentityFileName,
java.lang.String aIdentityPassPhrase)
Creates an instance of EPPSSLConfig that takes the required set of
attributes. |
Method Summary | |
---|---|
java.lang.String |
getIdentityFileName()
Gets the Identity File Name String . |
java.lang.String |
getIdentityKeyPassPhrase()
Gets the Identity Key Pass Phrase String using the
Identity Pass Phrase as the default value. |
char[] |
getIdentityKeyPassPhraseCharArray()
Gets the Identity Key Pass Phrase as char[] using the
Identity Pass Phrase as the default value. |
java.lang.String |
getIdentityPassPhrase()
Gets the Identity Pass Phrase String . |
char[] |
getIdentityPassPhraseCharArray()
Gets the Identity Pass Phrase as a char[] . |
java.lang.String |
getIdentityStoreType()
Gets the Identity Store Type String . |
java.lang.String |
getSslDebug()
Gets the SSL Debug String . |
java.lang.String[] |
getSSLEnabledCipherSuites()
Gets the optional SSL enabled cipher suites String array. |
java.lang.String[] |
getSSLEnabledProtocols()
Gets the optional SSL enabled protocols String array. |
java.lang.String |
getSslProtocol()
Gets the SSL Protocol String . |
java.lang.String |
getTrustStoreFileName()
Gets the Trust Store File Name String . |
java.lang.String |
getTrustStorePassPhrase()
Gets the Trust Store Pass Phrase String . |
char[] |
getTrustStorePassPhraseCharArray()
Gets the Trust Store Pass Phrase as char[] . |
java.lang.String |
getTrustStoreType()
Gets the Trust Store Type String . |
void |
setIdentityFileName(java.lang.String aIdentityFileName)
Sets the Identity File Name String . |
void |
setIdentityKeyPassPhrase(java.lang.String aIdentityKeyPassPhrase)
Sets the Identity Key Pass Phrase String . |
void |
setIdentityPassPhrase(java.lang.String aIdentityPassPhrase)
Sets the Identity Pass Phrase String . |
void |
setIdentityStoreType(java.lang.String aIdentityStoreType)
Sets the Identity Store Type String . |
void |
setSslDebug(java.lang.String aSslDebug)
Sets the SSL Debug String . |
void |
setSSLEnabledCipherSuites(java.lang.String aSslEnabledCipherSuites)
Sets the optional SSL enabled cipher suites using a space delimited list of cipher suites. |
void |
setSSLEnabledCipherSuites(java.lang.String[] aSslEnabledCipherSuites)
Sets the optional SSL enabled cipher suites String array. |
void |
setSSLEnabledProtocols(java.lang.String aSslEnabledProtocols)
Sets the optional SSL enabled protocols using a space delimited list of protocols. |
void |
setSSLEnabledProtocols(java.lang.String[] aSslEnabledProtocols)
Sets the optional SSL enabled protocols String array. |
void |
setSslProtocol(java.lang.String aSslProtocol)
Sets the SSL Protocol String . |
void |
setTrustStore(java.lang.String aTrustStoreType,
java.lang.String aTrustStoreFileName,
java.lang.String aTrustStorePassPhrase)
Sets the required Trust Store properties if the Trust Store is explicitely set. |
void |
setTrustStoreFileName(java.lang.String aTrustStoreFileName)
Sets the Trust Store File Name String . |
void |
setTrustStorePassPhrase(java.lang.String aTrustStorePassPhrase)
Sets the Trust Store Pass Phrase String . |
void |
setTrustStoreType(java.lang.String aTrustStoreType)
Sets the Trust Store Type String . |
java.lang.String |
toString()
Output the contents of the EPPSSLConfig instance
which includes a comma seperated list of EPPSSLConfig
properties with the values. |
void |
validate()
Validates the properties of the EPPSSLConfig by checking
that the required properties are set. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPSSLConfig()
public EPPSSLConfig(java.lang.String aSslProtocol, java.lang.String aIdentityStoreType, java.lang.String aIdentityFileName, java.lang.String aIdentityPassPhrase)
EPPSSLConfig
that takes the required set of
attributes.
aSslProtocol
- SSL Protocol like "TLS"aIdentityStoreType
- Identity store type like "JKS"aIdentityFileName
- Identity store file nameaIdentityPassPhrase
- Identity store passphrase/passwordMethod Detail |
---|
public java.lang.String getIdentityFileName()
String
.
String
if set; null
otherwise.public void setIdentityFileName(java.lang.String aIdentityFileName)
String
.
aIdentityFileName
- String
.public java.lang.String getIdentityKeyPassPhrase()
String
using the
Identity Pass Phrase as the default value.
public char[] getIdentityKeyPassPhraseCharArray()
char[]
using the
Identity Pass Phrase as the default value.
char[]
public void setIdentityKeyPassPhrase(java.lang.String aIdentityKeyPassPhrase)
String
.
aIdentityKeyPassPhrase
- String
.public java.lang.String getIdentityPassPhrase()
String
.
null
otherwise.public char[] getIdentityPassPhraseCharArray()
char[]
.
null
otherwise.public void setIdentityPassPhrase(java.lang.String aIdentityPassPhrase)
String
.
aIdentityPassPhrase
- String
.public java.lang.String getIdentityStoreType()
String
.
String
if set; null
otherwise.public void setIdentityStoreType(java.lang.String aIdentityStoreType)
String
.
aIdentityStoreType
- String
.public java.lang.String getSslDebug()
String
.
String
if set; null
otherwise.public void setSslDebug(java.lang.String aSslDebug)
String
.
aSslDebug
- String
.public java.lang.String getSslProtocol()
String
.
String
if set; null
otherwise.public void setSslProtocol(java.lang.String aSslProtocol)
String
.
aSslProtocol
- String
.public void setTrustStore(java.lang.String aTrustStoreType, java.lang.String aTrustStoreFileName, java.lang.String aTrustStorePassPhrase)
aTrustStoreType
- Keystore type of the Trust Store like "JKS"aTrustStoreFileName
- Trust Store file nameaTrustStorePassPhrase
- Trust Store passphrase/passwordpublic java.lang.String getTrustStoreType()
String
.
String
if set; null
otherwise.public void setTrustStoreType(java.lang.String aTrustStoreType)
String
.
aTrustStoreType
- String
.public java.lang.String getTrustStoreFileName()
String
.
String
if set; null
otherwise.public void setTrustStoreFileName(java.lang.String aTrustStoreFileName)
String
.
aTrustStoreFileName
- String
.public java.lang.String getTrustStorePassPhrase()
String
.
null
otherwise.public char[] getTrustStorePassPhraseCharArray()
char[]
.
null
otherwise.public void setTrustStorePassPhrase(java.lang.String aTrustStorePassPhrase)
String
.
aTrustStorePassPhrase
- String
.public java.lang.String[] getSSLEnabledProtocols()
String
array.
>String
array if set; null
otherwise.public void setSSLEnabledProtocols(java.lang.String[] aSslEnabledProtocols)
String
array.
aSslEnabledProtocols
- String
array of enabled SSL protocolspublic void setSSLEnabledProtocols(java.lang.String aSslEnabledProtocols)
aSslEnabledProtocols
- space delimited list of enabled SSL protocolspublic java.lang.String[] getSSLEnabledCipherSuites()
String
array.
>String
array if set; null
otherwise.public void setSSLEnabledCipherSuites(java.lang.String[] aSslEnabledCipherSuites)
String
array.
aSslEnabledCipherSuites
- String
array of enabled SSL cipher suitespublic void setSSLEnabledCipherSuites(java.lang.String aSslEnabledCipherSuites)
aSslEnabledCipherSuites
- space delimited list of enabled SSL cipher suitespublic void validate() throws EPPException
EPPSSLConfig
by checking
that the required properties are set.
EPPException
- On errorpublic java.lang.String toString()
EPPSSLConfig
instance
which includes a comma seperated list of EPPSSLConfig
properties with the values. For example, "sslProtocol = <value>".
toString
in class java.lang.Object
String
containing the EPPSSLConfig
properties and values
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |