Class EPPSSLClientSocket
- java.lang.Object
-
- com.verisign.epp.transport.client.EPPSSLClientSocket
-
- All Implemented Interfaces:
EPPClientCon
- Direct Known Subclasses:
EPPSSLProxyClientSocket
public class EPPSSLClientSocket extends java.lang.Object implements EPPClientCon
Secure Socket Layer client socket class that can be configured to connect to a server over SSL / TLS using theEPP.ClientSocketName
configuration property. The SSL settings are passed into theEPPSSLClientSocket
class using theEPPSSLContext
class.- See Also:
EPPSSLContext
-
-
Constructor Summary
Constructors Constructor Description EPPSSLClientSocket()
Default constructor that gets the following settings fromEPPEnv
:
hostName
- Defined with theEPPEnv.getServerName()
method.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Closing the connection.java.lang.String
getClientHostName()
Gets the client host name to use for the connection.int
getConTimeout()
Gets the connection timeout setting.java.lang.String
getHostName()
Gets the host name or IP address to connect to.java.io.InputStream
getInputStream()
Gets the input stream of theSocket
connection.java.io.OutputStream
getOutputStream()
Gets the output stream of theSocket
connection.int
getPortNumber()
Gets the port number to connect to.javax.net.ssl.SSLSocket
getSocket()
Gets the enclosingSSLSocket
of the connection.EPPSSLContext
getSslContext()
Gets theEPPSSLContext
to use for the SSL connection.protected java.lang.String
getSSLPropertyListString(java.lang.String[] aList)
Gets an SSL property list as a string for logging purposes.void
initialize()
Initializes an SSL connection to the host and port defined by the server name and the server port properties ofEPPEnv
.void
initialize(java.lang.String aHostName, int aPortNumber, EPPSSLContext aSSLContext)
Initializes a SSL connection to a specific host and port.void
initialize(java.lang.String aHostName, int aPortNumber, java.lang.String aClientHostName, EPPSSLContext aSSLContext)
Initializes a SSL connection to a specific host and port.boolean
isConnected()
Is the connection established?protected void
setClientHostName(java.lang.String aClientHostName)
Sets the client host name to use for the connection.protected void
setConnected(boolean aIsConnected)
Sets whether the connection is established.protected void
setConTimeout(int aConTimeout)
Sets the connection timeout setting.protected void
setHostName(java.lang.String aHostName)
Sets the host name or IP address to connect to.protected void
setInputStream(java.io.InputStream aInputStream)
Sets the input stream of theSocket
connection.protected void
setOutputStream(java.io.OutputStream aOutputStream)
Sets the output stream of theSocket
connection.protected void
setPortNumber(int aPortNumber)
Sets the port number to connect to.protected void
setSocket(javax.net.ssl.SSLSocket aSocket)
Sets theSSLSocket
to use.protected void
setSslContext(EPPSSLContext aSslContext)
Sets theEPPSSLContext
to use for the SSL connection
-
-
-
Constructor Detail
-
EPPSSLClientSocket
public EPPSSLClientSocket() throws EPPConException
Default constructor that gets the following settings fromEPPEnv
:
hostName
- Defined with theEPPEnv.getServerName()
method.portNumber
- Defined with theEPPEnv.getServerPort()
method.conTimeout
- Defined with theEPPEnv.getConTimeOut()
method.readTimeout
- Defined with theEPPEnv.getReadTimeOut()
method.clientHostName
- Defined with theEPPEnv.getClientHost()
method.
- Throws:
EPPConException
- If there is a problem getting the default connection properties fromEPPEnv
.
-
-
Method Detail
-
initialize
public void initialize() throws EPPConException
Initializes an SSL connection to the host and port defined by the server name and the server port properties ofEPPEnv
.- Specified by:
initialize
in interfaceEPPClientCon
- Throws:
EPPConException
- Error initializing the connection.
-
initialize
public void initialize(java.lang.String aHostName, int aPortNumber, EPPSSLContext aSSLContext) throws EPPConException
Initializes a SSL connection to a specific host and port. There remainder of the connection settings is derived from theEPPEnv
properties.- Specified by:
initialize
in interfaceEPPClientCon
- Parameters:
aHostName
- Host name or IP address of host to connect toaPortNumber
- Port number to connect toaSSLContext
- Optional specific SSL context to use- Throws:
EPPConException
- Error initializing the connection.
-
initialize
public void initialize(java.lang.String aHostName, int aPortNumber, java.lang.String aClientHostName, EPPSSLContext aSSLContext) throws EPPConException
Initializes a SSL connection to a specific host and port. There remainder of the connection settings is derived from theEPPEnv
properties.- Specified by:
initialize
in interfaceEPPClientCon
- Parameters:
aHostName
- Host name or IP address of host to connect toaPortNumber
- Port number to connect toaClientHostName
- Host name or IP address to connect fromaSSLContext
- Optional specific SSL context to use- Throws:
EPPConException
- Error initializing the connection.
-
getInputStream
public java.io.InputStream getInputStream() throws EPPConException
Gets the input stream of theSocket
connection.- Specified by:
getInputStream
in interfaceEPPClientCon
- Returns:
InputStream
of the connectedSocket
- Throws:
EPPConException
- Input stream not set
-
setInputStream
protected void setInputStream(java.io.InputStream aInputStream)
Sets the input stream of theSocket
connection. This can only be set by a derived class to support tunneling and other extensions.- Parameters:
aInputStream
- Input stream to set
-
getOutputStream
public java.io.OutputStream getOutputStream() throws EPPConException
Gets the output stream of theSocket
connection.- Specified by:
getOutputStream
in interfaceEPPClientCon
- Returns:
OutputStream
of the connectedSocket
- Throws:
EPPConException
- Output stream not set
-
setOutputStream
protected void setOutputStream(java.io.OutputStream aOutputStream)
Sets the output stream of theSocket
connection. This can only be set by a derived class to support tunneling and other extensions.- Parameters:
aOutputStream
- Output stream to set
-
getSocket
public javax.net.ssl.SSLSocket getSocket()
Gets the enclosingSSLSocket
of the connection.- Returns:
- Gets the enclosing
SSLSocket
if defined;null
otherwise.
-
setSocket
protected void setSocket(javax.net.ssl.SSLSocket aSocket)
Sets theSSLSocket
to use.- Parameters:
aSocket
-SSLSocket
to use
-
getSslContext
public EPPSSLContext getSslContext()
Gets theEPPSSLContext
to use for the SSL connection.- Returns:
EPPSSLContext
to use
-
setSslContext
protected void setSslContext(EPPSSLContext aSslContext)
Sets theEPPSSLContext
to use for the SSL connection- Parameters:
aSslContext
-EPPSSLContext
to use
-
getClientHostName
public java.lang.String getClientHostName()
Gets the client host name to use for the connection.- Returns:
- Client host name if set;
null
otherwise.
-
setClientHostName
protected void setClientHostName(java.lang.String aClientHostName)
Sets the client host name to use for the connection.- Parameters:
aClientHostName
- Client host name to use
-
getHostName
public java.lang.String getHostName()
Gets the host name or IP address to connect to.- Returns:
- host name or IP address to connect to
-
setHostName
protected void setHostName(java.lang.String aHostName)
Sets the host name or IP address to connect to.- Parameters:
aHostName
- Host name or IP address to connect to
-
getPortNumber
public int getPortNumber()
Gets the port number to connect to.- Returns:
- port number to connect to
-
setPortNumber
protected void setPortNumber(int aPortNumber)
Sets the port number to connect to.- Parameters:
aPortNumber
- Port number to connect to
-
getConTimeout
public int getConTimeout()
Gets the connection timeout setting.- Returns:
- connection timeout
-
setConTimeout
protected void setConTimeout(int aConTimeout)
Sets the connection timeout setting.- Parameters:
aConTimeout
- connection timeout
-
isConnected
public boolean isConnected()
Is the connection established?- Returns:
true
if connected;false
otherwise.
-
setConnected
protected void setConnected(boolean aIsConnected)
Sets whether the connection is established.- Parameters:
aIsConnected
-true
if connected;false
otherwise
-
close
public void close() throws EPPConException
Closing the connection.- Specified by:
close
in interfaceEPPClientCon
- Throws:
EPPConException
- Error closing the connection
-
getSSLPropertyListString
protected java.lang.String getSSLPropertyListString(java.lang.String[] aList)
Gets an SSL property list as a string for logging purposes. Examples of SSL property lists include supported protocols, enabled protocols, supported cipher suites, and enabled cipher suites.- Parameters:
aList
-Array
ofString
's.- Returns:
- Space delimited
String
representing the property list ifaList
is notnull
;null
otherwise
-
-