SSLSocketImpl (CryptoPro Java TLS)

java.lang.Object
- java.net.Socket
- - javax.net.ssl.SSLSocket
  - - ru.CryptoPro.ssl.SSLSocketImpl

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public final class SSLSocketImpl
extends javax.net.ssl.SSLSocket
```
Implementation of an SSL socket. This is a normal connection type socket, implementing SSL over some lower level socket, such as TCP. Because it is layered over some lower level socket, it MUST override all default socket methods.
This API offers a non-traditional option for establishing SSL connections. You may first establish the connection directly, then pass that connection to the SSL socket constructor with a flag saying which role should be taken in the handshake protocol. (The two ends of the connection must not choose the same role!) This allows setup of SSL proxying or tunneling, and also allows the kind of "role reversal" that is required for most FTP data transfers.

See Also:

SSLSocket, SSLServerSocket

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)` Registers an event listener to receive notifications that an SSL handshake has completed on this connection.
`void`	`bind(java.net.SocketAddress arg0)`
`void`	`close()` Closes the SSL connection.
`void`	`connect(java.net.SocketAddress arg0)`
`void`	`connect(java.net.SocketAddress endpoint, int timeout)` Connects this socket to the server with a specified timeout value.
`java.lang.String`	`getApplicationProtocol()`
`java.nio.channels.SocketChannel`	`getChannel()`
`java.lang.String[]`	`getEnabledCipherSuites()` Returns the names of the SSL cipher suites which are currently enabled for use on this connection.
`java.lang.String[]`	`getEnabledProtocols()`
`boolean`	`getEnableSessionCreation()` Returns true if new connections may cause creation of new SSL sessions.
`javax.net.ssl.SSLSession`	`getHandshakeSession()`
`java.net.InetAddress`	`getInetAddress()`
`java.io.InputStream`	`getInputStream()` Gets an input stream to read from the peer on the other side.
`boolean`	`getKeepAlive()`
`java.net.InetAddress`	`getLocalAddress()`
`int`	`getLocalPort()`
`java.net.SocketAddress`	`getLocalSocketAddress()`
`boolean`	`getNeedClientAuth()`
`boolean`	`getOOBInline()`
`java.io.OutputStream`	`getOutputStream()` Gets an output stream to write to the peer on the other side.
`int`	`getPort()`
`int`	`getReceiveBufferSize()`
`java.net.SocketAddress`	`getRemoteSocketAddress()`
`boolean`	`getReuseAddress()`
`int`	`getSendBufferSize()`
`javax.net.ssl.SSLSession`	`getSession()` Returns the the SSL Session in use by this connection.
`int`	`getSoLinger()`
`int`	`getSoTimeout()`
`javax.net.ssl.SSLParameters`	`getSSLParameters()` Returns the SSLParameters in effect for this SSLSocket.
`java.lang.String[]`	`getSupportedCipherSuites()` Returns the names of the cipher suites which could be enabled for use on an SSL connection.
`java.lang.String[]`	`getSupportedProtocols()` Returns the protocols that are supported by this implementation.
`boolean`	`getTcpNoDelay()`
`int`	`getTrafficClass()`
`boolean`	`getUseClientMode()`
`boolean`	`getWantClientAuth()`
`boolean`	`isBound()`
`boolean`	`isClosed()` Return whether the socket has been explicitly closed by the application.
`boolean`	`isConnected()`
`boolean`	`isInputShutdown()`
`boolean`	`isOutputShutdown()`
`void`	`removeHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)` Removes a previously registered handshake completion listener.
`void`	`sendUrgentData(int arg0)`
`void`	`setEnabledCipherSuites(java.lang.String[] suites)` Controls which particular cipher suites are enabled for use on this connection.
`void`	`setEnabledProtocols(java.lang.String[] protocols)` Controls which protocols are enabled for use on this connection.
`void`	`setEnableSessionCreation(boolean flag)` Controls whether new connections may cause creation of new SSL sessions.
`void`	`setKeepAlive(boolean arg0)`
`void`	`setNeedClientAuth(boolean flag)` Sets the flag controlling whether a server mode socket REQUIRES SSL client authentication.
`void`	`setOOBInline(boolean arg0)`
`void`	`setPerformancePreferences(int arg0, int arg1, int arg2)`
`void`	`setReceiveBufferSize(int arg0)`
`void`	`setReuseAddress(boolean arg0)`
`void`	`setSendBufferSize(int arg0)`
`void`	`setSoLinger(boolean arg0, int arg1)`
`void`	`setSoTimeout(int timeout)` Assigns the socket timeout.
`void`	`setSSLParameters(javax.net.ssl.SSLParameters params)` Applies SSLParameters to this socket.
`void`	`setTcpNoDelay(boolean arg0)`
`void`	`setTrafficClass(int arg0)`
`void`	`setUseClientMode(boolean flag)` Sets the flag controlling whether the socket is in SSL client or server mode.
`void`	`setWantClientAuth(boolean flag)` Sets the flag controlling whether a server mode socket REQUESTS SSL client authentication.
`void`	`shutdownInput()`
`void`	`shutdownOutput()`
`void`	`startHandshake()` Starts an SSL handshake on this connection.
`java.lang.String`	`toString()` Returns a printable representation of this end of the connection.

Methods inherited from class java.net.Socket
setSocketImplFactory

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - connect
```
public void connect(java.net.SocketAddress endpoint,
                    int timeout)
             throws java.io.IOException
```
    Connects this socket to the server with a specified timeout value. This method is either called on an unconnected SSLSocketImpl by the application, or it is called in the constructor of a regular SSLSocketImpl. If we are layering on top on another socket, then this method should not be called, because we assume that the underlying socket is already connected by the time it is passed to us.
    
    Overrides:
    
    connect in class java.net.Socket
    
    Parameters:
    
    endpoint - the SocketAddress
    
    timeout - the timeout value to be used, 0 is no timeout
    
    Throws:
    
    java.io.IOException - if an error occurs during the connection
    
    java.net.SocketTimeoutException - if timeout expires before connecting
  - startHandshake
```
public void startHandshake()
                    throws java.io.IOException
```
    Starts an SSL handshake on this connection.
    
    Specified by:
    
    startHandshake in class javax.net.ssl.SSLSocket
    
    Throws:
    
    java.io.IOException
  - isClosed
```
public boolean isClosed()
```
    Return whether the socket has been explicitly closed by the application.
    
    Overrides:
    
    isClosed in class java.net.Socket
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the SSL connection. SSL includes an application level shutdown handshake; you should close SSL sockets explicitly rather than leaving it for finalization, so that your remote peer does not experience a protocol error.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Gets an input stream to read from the peer on the other side. Data read from this stream was always integrity protected in transit, and will usually have been confidentiality protected.
    
    Throws:
    
    java.io.IOException
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Gets an output stream to write to the peer on the other side. Data written on this stream is always integrity protected, and will usually be confidentiality protected.
    
    Throws:
    
    java.io.IOException
  - getSession
```
public javax.net.ssl.SSLSession getSession()
```
    Returns the the SSL Session in use by this connection. These can be long lived, and frequently correspond to an entire login session for some user.
    
    Specified by:
    
    getSession in class javax.net.ssl.SSLSocket
  - getHandshakeSession
```
public javax.net.ssl.SSLSession getHandshakeSession()
```
    Overrides:
    
    getHandshakeSession in class javax.net.ssl.SSLSocket
  - setEnableSessionCreation
```
public void setEnableSessionCreation(boolean flag)
```
    Controls whether new connections may cause creation of new SSL sessions. As long as handshaking has not started, we can change whether we enable session creations. Otherwise, we will need to wait for the next handshake.
    
    Specified by:
    
    setEnableSessionCreation in class javax.net.ssl.SSLSocket
  - getEnableSessionCreation
```
public boolean getEnableSessionCreation()
```
    Returns true if new connections may cause creation of new SSL sessions.
    
    Specified by:
    
    getEnableSessionCreation in class javax.net.ssl.SSLSocket
  - setNeedClientAuth
```
public void setNeedClientAuth(boolean flag)
```
    Sets the flag controlling whether a server mode socket *REQUIRES* SSL client authentication. As long as handshaking has not started, we can change whether client authentication is needed. Otherwise, we will need to wait for the next handshake.
    
    Specified by:
    
    setNeedClientAuth in class javax.net.ssl.SSLSocket
  - getNeedClientAuth
```
public boolean getNeedClientAuth()
```
    Specified by:
    
    getNeedClientAuth in class javax.net.ssl.SSLSocket
  - setWantClientAuth
```
public void setWantClientAuth(boolean flag)
```
    Sets the flag controlling whether a server mode socket *REQUESTS* SSL client authentication. As long as handshaking has not started, we can change whether client authentication is requested. Otherwise, we will need to wait for the next handshake.
    
    Specified by:
    
    setWantClientAuth in class javax.net.ssl.SSLSocket
  - getWantClientAuth
```
public boolean getWantClientAuth()
```
    Specified by:
    
    getWantClientAuth in class javax.net.ssl.SSLSocket
  - setUseClientMode
```
public void setUseClientMode(boolean flag)
```
    Sets the flag controlling whether the socket is in SSL client or server mode. Must be called before any SSL traffic has started.
    
    Specified by:
    
    setUseClientMode in class javax.net.ssl.SSLSocket
  - getUseClientMode
```
public boolean getUseClientMode()
```
    Specified by:
    
    getUseClientMode in class javax.net.ssl.SSLSocket
  - getSupportedCipherSuites
```
public java.lang.String[] getSupportedCipherSuites()
```
    Returns the names of the cipher suites which could be enabled for use on an SSL connection. Normally, only a subset of these will actually be enabled by default, since this list may include cipher suites which do not support the mutual authentication of servers and clients, or which do not protect data confidentiality. Servers may also need certain kinds of certificates to use certain cipher suites.
    
    Specified by:
    
    getSupportedCipherSuites in class javax.net.ssl.SSLSocket
    
    Returns:
    
    an array of cipher suite names
  - setEnabledCipherSuites
```
public void setEnabledCipherSuites(java.lang.String[] suites)
```
    Controls which particular cipher suites are enabled for use on this connection. The cipher suites must have been listed by getCipherSuites() as being supported. Even if a suite has been enabled, it might never be used if no peer supports it or the requisite certificates (and private keys) are not available.
    
    Specified by:
    
    setEnabledCipherSuites in class javax.net.ssl.SSLSocket
    
    Parameters:
    
    suites - Names of all the cipher suites to enable.
  - getEnabledCipherSuites
```
public java.lang.String[] getEnabledCipherSuites()
```
    Returns the names of the SSL cipher suites which are currently enabled for use on this connection. When an SSL socket is first created, all enabled cipher suites (a) protect data confidentiality, by traffic encryption, and (b) can mutually authenticate both clients and servers. Thus, in some environments, this value might be empty.
    
    Specified by:
    
    getEnabledCipherSuites in class javax.net.ssl.SSLSocket
    
    Returns:
    
    an array of cipher suite names
  - getSupportedProtocols
```
public java.lang.String[] getSupportedProtocols()
```
    Returns the protocols that are supported by this implementation. A subset of the supported protocols may be enabled for this connection
    
    Specified by:
    
    getSupportedProtocols in class javax.net.ssl.SSLSocket
    
    Returns:
    
    an array of protocol names.
  - setEnabledProtocols
```
public void setEnabledProtocols(java.lang.String[] protocols)
```
    Controls which protocols are enabled for use on this connection. The protocols must have been listed by getSupportedProtocols() as being supported.
    
    Specified by:
    
    setEnabledProtocols in class javax.net.ssl.SSLSocket
    
    Parameters:
    
    protocols - protocols to enable.
    
    Throws:
    
    java.lang.IllegalArgumentException - when one of the protocols named by the parameter is not supported.
  - getEnabledProtocols
```
public java.lang.String[] getEnabledProtocols()
```
    Specified by:
    
    getEnabledProtocols in class javax.net.ssl.SSLSocket
  - setSoTimeout
```
public void setSoTimeout(int timeout)
                  throws java.net.SocketException
```
    Assigns the socket timeout.
    
    Throws:
    
    java.net.SocketException
    
    See Also:
    
    Socket.setSoTimeout(int)
  - addHandshakeCompletedListener
```
public void addHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)
```
    Registers an event listener to receive notifications that an SSL handshake has completed on this connection.
    
    Specified by:
    
    addHandshakeCompletedListener in class javax.net.ssl.SSLSocket
  - removeHandshakeCompletedListener
```
public void removeHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)
```
    Removes a previously registered handshake completion listener.
    
    Specified by:
    
    removeHandshakeCompletedListener in class javax.net.ssl.SSLSocket
  - getSSLParameters
```
public javax.net.ssl.SSLParameters getSSLParameters()
```
    Returns the SSLParameters in effect for this SSLSocket.
    
    Overrides:
    
    getSSLParameters in class javax.net.ssl.SSLSocket
  - setSSLParameters
```
public void setSSLParameters(javax.net.ssl.SSLParameters params)
```
    Applies SSLParameters to this socket.
    
    Overrides:
    
    setSSLParameters in class javax.net.ssl.SSLSocket
  - getApplicationProtocol
```
public java.lang.String getApplicationProtocol()
```
  - toString
```
public java.lang.String toString()
```
    Returns a printable representation of this end of the connection.
  - getChannel
```
public final java.nio.channels.SocketChannel getChannel()
```
    Overrides:
    
    getChannel in class java.net.Socket
  - bind
```
public void bind(java.net.SocketAddress arg0)
          throws java.io.IOException
```
    Overrides:
    
    bind in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - getLocalSocketAddress
```
public java.net.SocketAddress getLocalSocketAddress()
```
    Overrides:
    
    getLocalSocketAddress in class java.net.Socket
  - getRemoteSocketAddress
```
public java.net.SocketAddress getRemoteSocketAddress()
```
    Overrides:
    
    getRemoteSocketAddress in class java.net.Socket
  - connect
```
public final void connect(java.net.SocketAddress arg0)
                   throws java.io.IOException
```
    Overrides:
    
    connect in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - isConnected
```
public final boolean isConnected()
```
    Overrides:
    
    isConnected in class java.net.Socket
  - isBound
```
public final boolean isBound()
```
    Overrides:
    
    isBound in class java.net.Socket
  - shutdownInput
```
public final void shutdownInput()
                         throws java.io.IOException
```
    Overrides:
    
    shutdownInput in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - shutdownOutput
```
public final void shutdownOutput()
                          throws java.io.IOException
```
    Overrides:
    
    shutdownOutput in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - isInputShutdown
```
public final boolean isInputShutdown()
```
    Overrides:
    
    isInputShutdown in class java.net.Socket
  - isOutputShutdown
```
public final boolean isOutputShutdown()
```
    Overrides:
    
    isOutputShutdown in class java.net.Socket
  - getInetAddress
```
public final java.net.InetAddress getInetAddress()
```
    Overrides:
    
    getInetAddress in class java.net.Socket
  - getLocalAddress
```
public final java.net.InetAddress getLocalAddress()
```
    Overrides:
    
    getLocalAddress in class java.net.Socket
  - getPort
```
public final int getPort()
```
    Overrides:
    
    getPort in class java.net.Socket
  - getLocalPort
```
public final int getLocalPort()
```
    Overrides:
    
    getLocalPort in class java.net.Socket
  - setTcpNoDelay
```
public final void setTcpNoDelay(boolean arg0)
                         throws java.net.SocketException
```
    Overrides:
    
    setTcpNoDelay in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getTcpNoDelay
```
public final boolean getTcpNoDelay()
                            throws java.net.SocketException
```
    Overrides:
    
    getTcpNoDelay in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setSoLinger
```
public final void setSoLinger(boolean arg0,
                              int arg1)
                       throws java.net.SocketException
```
    Overrides:
    
    setSoLinger in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getSoLinger
```
public final int getSoLinger()
                      throws java.net.SocketException
```
    Overrides:
    
    getSoLinger in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - sendUrgentData
```
public final void sendUrgentData(int arg0)
                          throws java.net.SocketException
```
    Overrides:
    
    sendUrgentData in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setOOBInline
```
public final void setOOBInline(boolean arg0)
                        throws java.net.SocketException
```
    Overrides:
    
    setOOBInline in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getOOBInline
```
public final boolean getOOBInline()
                           throws java.net.SocketException
```
    Overrides:
    
    getOOBInline in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getSoTimeout
```
public final int getSoTimeout()
                       throws java.net.SocketException
```
    Overrides:
    
    getSoTimeout in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setSendBufferSize
```
public final void setSendBufferSize(int arg0)
                             throws java.net.SocketException
```
    Overrides:
    
    setSendBufferSize in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getSendBufferSize
```
public final int getSendBufferSize()
                            throws java.net.SocketException
```
    Overrides:
    
    getSendBufferSize in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setReceiveBufferSize
```
public final void setReceiveBufferSize(int arg0)
                                throws java.net.SocketException
```
    Overrides:
    
    setReceiveBufferSize in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getReceiveBufferSize
```
public final int getReceiveBufferSize()
                               throws java.net.SocketException
```
    Overrides:
    
    getReceiveBufferSize in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setKeepAlive
```
public final void setKeepAlive(boolean arg0)
                        throws java.net.SocketException
```
    Overrides:
    
    setKeepAlive in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getKeepAlive
```
public final boolean getKeepAlive()
                           throws java.net.SocketException
```
    Overrides:
    
    getKeepAlive in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setTrafficClass
```
public final void setTrafficClass(int arg0)
                           throws java.net.SocketException
```
    Overrides:
    
    setTrafficClass in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getTrafficClass
```
public final int getTrafficClass()
                          throws java.net.SocketException
```
    Overrides:
    
    getTrafficClass in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setReuseAddress
```
public final void setReuseAddress(boolean arg0)
                           throws java.net.SocketException
```
    Overrides:
    
    setReuseAddress in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getReuseAddress
```
public final boolean getReuseAddress()
                              throws java.net.SocketException
```
    Overrides:
    
    getReuseAddress in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setPerformancePreferences
```
public void setPerformancePreferences(int arg0,
                                      int arg1,
                                      int arg2)
```
    Overrides:
    
    setPerformancePreferences in class java.net.Socket

Class SSLSocketImpl

Method Summary

Methods inherited from class java.net.Socket

Methods inherited from class java.lang.Object

Method Detail

connect

startHandshake

isClosed

close

getInputStream

getOutputStream

getSession

getHandshakeSession

setEnableSessionCreation

getEnableSessionCreation

setNeedClientAuth

getNeedClientAuth

setWantClientAuth

getWantClientAuth

setUseClientMode

getUseClientMode

getSupportedCipherSuites

setEnabledCipherSuites

getEnabledCipherSuites

getSupportedProtocols

setEnabledProtocols

getEnabledProtocols

setSoTimeout

addHandshakeCompletedListener

removeHandshakeCompletedListener

getSSLParameters

setSSLParameters

getApplicationProtocol

toString

getChannel

bind

getLocalSocketAddress

getRemoteSocketAddress

connect

isConnected

isBound

shutdownInput

shutdownOutput

isInputShutdown

isOutputShutdown

getInetAddress

getLocalAddress

getPort

getLocalPort

setTcpNoDelay

getTcpNoDelay

setSoLinger

getSoLinger

sendUrgentData

setOOBInline

getOOBInline

getSoTimeout

setSendBufferSize

getSendBufferSize

setReceiveBufferSize

getReceiveBufferSize

setKeepAlive

getKeepAlive

setTrafficClass

getTrafficClass

setReuseAddress

getReuseAddress

setPerformancePreferences