Package org.conscrypt

Class OpenSSLSocketImplWrapper

java.lang.Object

java.net.Socket

javax.net.ssl.SSLSocket

org.conscrypt.OpenSSLSocketImpl

org.conscrypt.OpenSSLSocketImplWrapper

All Implemented Interfaces:

Closeable, AutoCloseable, NativeCrypto.SSLHandshakeCallbacks

public class OpenSSLSocketImplWrapper
extends OpenSSLSocketImpl

This class wraps the SSL functionality over an existing connected socket.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenSSLSocketImplWrapper(Socket socket, String host, int port, boolean autoClose, SSLParametersImpl sslParameters)

Method Summary

Modifier and Type	Method	Description
void	bind(SocketAddress sockaddr)	Binds this socket to the given local host address and port specified by the SocketAddress localAddr.
void	connect(SocketAddress sockaddr)	Connects this socket to the given remote host address and port specified by the SocketAddress remoteAddr.
void	connect(SocketAddress sockaddr, int timeout)	Connects this socket to the given remote host address and port specified by the SocketAddress remoteAddr with the specified timeout.
InetAddress	getInetAddress()	Returns the IP address of the target host this socket is connected to, or null if this socket is not yet connected.
boolean	getKeepAlive()	Returns this socket's SocketOptions.SO_KEEPALIVE setting.
InetAddress	getLocalAddress()	Returns the local IP address this socket is bound to, or InetAddress.ANY if the socket is unbound.
int	getLocalPort()	Returns the local port this socket is bound to, or -1 if the socket is unbound.
SocketAddress	getLocalSocketAddress()	Returns the local address and port of this socket as a SocketAddress or null if the socket is unbound.
boolean	getOOBInline()	Returns this socket's SocketOptions.SO_OOBINLINE setting.
int	getPort()	Returns the port number of the target host this socket is connected to, or 0 if this socket is not yet connected.
int	getReceiveBufferSize()	Returns this socket's receive buffer size.
SocketAddress	getRemoteSocketAddress()	Returns the remote address and port of this socket as a SocketAddress or null if the socket is not connected.
boolean	getReuseAddress()	Returns this socket's SocketOptions.SO_REUSEADDR setting.
int	getSendBufferSize()	Returns this socket's send buffer size.
int	getSoLinger()	Returns this socket's linger timeout in seconds, or -1 for no linger (i.e.
int	getSoTimeout()	Returns this socket's receive timeout.
boolean	getTcpNoDelay()	Returns this socket's SocketOptions#TCP_NODELAY setting.
int	getTrafficClass()	Returns this socket's {@see SocketOptions#IP_TOS} setting.
boolean	isBound()	Returns whether this socket is bound to a local address and port.
boolean	isClosed()	Returns whether this socket is closed.
boolean	isConnected()	Returns whether this socket is connected to a remote host.
boolean	isInputShutdown()	Returns whether the incoming channel of the socket has already been closed.
boolean	isOutputShutdown()	Returns whether the outgoing channel of the socket has already been closed.
void	setKeepAlive(boolean on)	Sets this socket's SocketOptions.SO_KEEPALIVE option.
void	setReceiveBufferSize(int size)	Sets this socket's receive buffer size.
void	setReuseAddress(boolean on)	Sets this socket's SocketOptions.SO_REUSEADDR option.
void	setSendBufferSize(int size)	Sets this socket's send buffer size.
void	setSoLinger(boolean on, int linger)	Sets this socket's linger timeout in seconds.
void	setSoTimeout(int to)	Sets this socket's read timeout in milliseconds.
void	setTcpNoDelay(boolean on)	Sets this socket's SocketOptions.TCP_NODELAY option.
void	setTrafficClass(int tos)	Sets this socket's SocketOptions.IP_TOS value for every packet sent by this socket.
String	toString()	Returns a String containing a concise, human-readable description of the socket.

Methods inherited from class org.conscrypt.OpenSSLSocketImpl

addHandshakeCompletedListener, clientCertificateRequested, close, finalize, getAlpnSelectedProtocol, getChannelId, getEnabledCipherSuites, getEnabledProtocols, getEnableSessionCreation, getFileDescriptor$, getInputStream, getNeedClientAuth, getNpnSelectedProtocol, getOutputStream, getSession, getSoWriteTimeout, getSupportedCipherSuites, getSupportedProtocols, getUseClientMode, getWantClientAuth, handshakeCompleted, removeHandshakeCompletedListener, sendUrgentData, setAlpnProtocols, setChannelIdEnabled, setChannelIdPrivateKey, setEnabledCipherSuites, setEnabledProtocols, setEnableSessionCreation, setHandshakeTimeout, setHostname, setNeedClientAuth, setNpnProtocols, setOOBInline, setSoWriteTimeout, setUseClientMode, setUseSessionTickets, setWantClientAuth, startHandshake, verifyCertificateChain

Methods inherited from class javax.net.ssl.SSLSocket

getSSLParameters, setSSLParameters, shutdownInput, shutdownOutput

Methods inherited from class java.net.Socket

getChannel, setPerformancePreferences, setSocketImplFactory

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OpenSSLSocketImplWrapper

protected OpenSSLSocketImplWrapper(Socket socket,
String host,
int port,
boolean autoClose,
SSLParametersImpl sslParameters)
                            throws IOException

Throws:

IOException

Method Details

connect

public void connect(SocketAddress sockaddr,
int timeout)
             throws IOException

Description copied from class: Socket

Connects this socket to the given remote host address and port specified by the SocketAddress remoteAddr with the specified timeout. The connecting method will block until the connection is established or an error occurred.

Overrides:

connect in class Socket

Parameters:

sockaddr - the address and port of the remote host to connect to.

timeout - the timeout value in milliseconds or 0 for an infinite timeout.

Throws:

IOException - if the socket is already connected or an error occurs while connecting.

connect

public void connect(SocketAddress sockaddr)
             throws IOException

Description copied from class: Socket

Connects this socket to the given remote host address and port specified by the SocketAddress remoteAddr.

Overrides:

connect in class Socket

Parameters:

sockaddr - the address and port of the remote host to connect to.

Throws:

IOException - if the socket is already connected or an error occurs while connecting.

bind

public void bind(SocketAddress sockaddr)
          throws IOException

Description copied from class: Socket

Binds this socket to the given local host address and port specified by the SocketAddress localAddr. If localAddr is set to null, this socket will be bound to an available local address on any free port.

Overrides:

bind in class Socket

Parameters:

sockaddr - the specific address and port on the local machine to bind to.

Throws:

IOException - if the socket is already bound or an error occurs while binding.

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Description copied from class: Socket

Returns the remote address and port of this socket as a SocketAddress or null if the socket is not connected.

Overrides:

getRemoteSocketAddress in class Socket

Returns:

the remote socket address and port.

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Description copied from class: Socket

Returns the local address and port of this socket as a SocketAddress or null if the socket is unbound. This is useful on multihomed hosts.

Overrides:

getLocalSocketAddress in class Socket

getLocalAddress

public InetAddress getLocalAddress()

Description copied from class: Socket

Returns the local IP address this socket is bound to, or InetAddress.ANY if the socket is unbound.

Overrides:

getLocalAddress in class Socket

getInetAddress

public InetAddress getInetAddress()

Description copied from class: Socket

Returns the IP address of the target host this socket is connected to, or null if this socket is not yet connected.

Overrides:

getInetAddress in class Socket

toString

public String toString()

Description copied from class: Socket

Returns a String containing a concise, human-readable description of the socket.

Overrides:

toString in class Socket

Returns:

the textual representation of this socket.

setSoLinger

public void setSoLinger(boolean on,
int linger)
                 throws SocketException

Description copied from class: Socket

Sets this socket's linger timeout in seconds. If on is false, timeout is irrelevant.

Overrides:

setSoLinger in class Socket

Throws:

SocketException

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws SocketException

Description copied from class: Socket

Sets this socket's SocketOptions.TCP_NODELAY option.

Overrides:

setTcpNoDelay in class Socket

Throws:

SocketException

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException

Description copied from class: Socket

Sets this socket's SocketOptions.SO_REUSEADDR option.

Overrides:

setReuseAddress in class Socket

Throws:

SocketException

setKeepAlive

public void setKeepAlive(boolean on)
                  throws SocketException

Description copied from class: Socket

Sets this socket's SocketOptions.SO_KEEPALIVE option.

Overrides:

setKeepAlive in class Socket

Throws:

SocketException

setTrafficClass

public void setTrafficClass(int tos)
                     throws SocketException

Description copied from class: Socket

Sets this socket's SocketOptions.IP_TOS value for every packet sent by this socket.

Overrides:

setTrafficClass in class Socket

Throws:

SocketException

setSoTimeout

public void setSoTimeout(int to)
                  throws SocketException

Description copied from class: Socket

Sets this socket's read timeout in milliseconds. Use 0 for no timeout. To take effect, this option must be set before the blocking method was called.

Overrides:

setSoTimeout in class OpenSSLSocketImpl

Throws:

SocketException

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException

Description copied from class: Socket

Sets this socket's send buffer size.

Overrides:

setSendBufferSize in class Socket

Throws:

SocketException

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Description copied from class: Socket

Sets this socket's receive buffer size.

Overrides:

setReceiveBufferSize in class Socket

Throws:

SocketException

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException

Description copied from class: Socket

Returns this socket's SocketOptions#TCP_NODELAY setting.

Overrides:

getTcpNoDelay in class Socket

Throws:

SocketException

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Description copied from class: Socket

Returns this socket's SocketOptions.SO_REUSEADDR setting.

Overrides:

getReuseAddress in class Socket

Throws:

SocketException

getOOBInline

public boolean getOOBInline()
                     throws SocketException

Description copied from class: Socket

Returns this socket's SocketOptions.SO_OOBINLINE setting.

Overrides:

getOOBInline in class Socket

Throws:

SocketException

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException

Description copied from class: Socket

Returns this socket's SocketOptions.SO_KEEPALIVE setting.

Overrides:

getKeepAlive in class Socket

Throws:

SocketException

getTrafficClass

public int getTrafficClass()
                    throws SocketException

Description copied from class: Socket

Returns this socket's {@see SocketOptions#IP_TOS} setting.

Overrides:

getTrafficClass in class Socket

Throws:

SocketException

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Description copied from class: Socket

Returns this socket's receive timeout.

Overrides:

getSoTimeout in class OpenSSLSocketImpl

Throws:

SocketException

getSoLinger

public int getSoLinger()
                throws SocketException

Description copied from class: Socket

Returns this socket's linger timeout in seconds, or -1 for no linger (i.e. close will return immediately).

Overrides:

getSoLinger in class Socket

Throws:

SocketException

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Description copied from class: Socket

Returns this socket's send buffer size.

Overrides:

getSendBufferSize in class Socket

Throws:

SocketException

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Description copied from class: Socket

Returns this socket's receive buffer size.

Overrides:

getReceiveBufferSize in class Socket

Throws:

SocketException

isConnected

public boolean isConnected()

Description copied from class: Socket

Returns whether this socket is connected to a remote host.

Overrides:

isConnected in class Socket

Returns:

true if the socket is connected, false otherwise.

isClosed

public boolean isClosed()

Description copied from class: Socket

Returns whether this socket is closed.

Overrides:

isClosed in class Socket

Returns:

true if the socket is closed, false otherwise.

isBound

public boolean isBound()

Description copied from class: Socket

Returns whether this socket is bound to a local address and port.

Overrides:

isBound in class Socket

Returns:

true if the socket is bound to a local address, false otherwise.

isOutputShutdown

public boolean isOutputShutdown()

Description copied from class: Socket

Returns whether the outgoing channel of the socket has already been closed.

Overrides:

isOutputShutdown in class Socket

Returns:

true if writing to this socket is not possible anymore, false otherwise.

isInputShutdown

public boolean isInputShutdown()

Description copied from class: Socket

Returns whether the incoming channel of the socket has already been closed.

Overrides:

isInputShutdown in class Socket

Returns:

true if reading from this socket is not possible anymore, false otherwise.

getPort

public int getPort()

Description copied from class: Socket

Returns the port number of the target host this socket is connected to, or 0 if this socket is not yet connected.

Overrides:

getPort in class Socket

getLocalPort

public int getLocalPort()

Description copied from class: Socket

Returns the local port this socket is bound to, or -1 if the socket is unbound.

Overrides:

getLocalPort in class Socket