Class JSSSocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.SocketChannel

org.mozilla.jss.ssl.javax.JSSSocketChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, NetworkChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel

public class JSSSocketChannel
extends SocketChannel

SSL-enabled SocketChannel following the javax.net.ssl.SSLSocket interface. This class should never be constructed directly and instead only accessed once a Socket is wrapped in a JSSSocket. This class contains all low-level interactions with the underlying SSLEngine and reading/writing to/from the underlying Socket.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	autoClose
private InputStream	consumed
private ReadableByteChannel	consumedChannel
private ByteBuffer	empty
private JSSEngine	engine
private boolean	handshakeCompleted
private boolean	inboundClosed
private boolean	outboundClosed
private SocketChannel	parent
private Socket	parentSocket
private ByteBuffer	readBuffer
private ReadableByteChannel	readChannel
private JSSSocket	sslSocket
private ByteBuffer	writeBuffer
private WritableByteChannel	writeChannel

Constructor Summary

Constructors

Constructor	Description
JSSSocketChannel(JSSSocket sslSocket, Socket parentSocket, ReadableByteChannel readChannel, WritableByteChannel writeChannel, JSSEngine engine)
JSSSocketChannel(JSSSocket sslSocket, SocketChannel parent, Socket parentSocket, ReadableByteChannel readChannel, WritableByteChannel writeChannel, JSSEngine engine)
JSSSocketChannel(JSSSocket sslSocket, SocketChannel parent, JSSEngine engine)

Method Summary

Modifier and Type	Method	Description
JSSSocketChannel	bind(SocketAddress local)
private static long	computeSize(ByteBuffer[] buffers, int offset, int length)	Compute the total size of a list of buffers from the specified offest and length.
boolean	connect(SocketAddress remote)
boolean	finishConnect()
Collection<? extends EventListener>	getListeners()	Gets the current list of event listeners this SSLSocket will fire on certain events.
SocketAddress	getLocalAddress()
<T> T	getOption(SocketOption<T> name)
SocketAddress	getRemoteAddress()
void	implCloseSelectableChannel()
void	implConfigureBlocking(boolean block)
boolean	isConnected()
boolean	isConnectionPending()
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts, int offset, int length)
private int	remoteRead()
void	setAutoClose(boolean on)	Set whether or not to close the underlying Socket when the SSLSocket or this channel is closed.
void	setConsumedData(InputStream consumed)	Give data already consumed by a call to the underlying socket's read method to this Socket, allowing it to be read by the SSLEngine.
void	setListeners(Collection<? extends EventListener> listeners)	Set the listeners this SSLSocket will fire on certain events.
<T> JSSSocketChannel	setOption(SocketOption<T> name, T value)
JSSSocketChannel	shutdownInput()
JSSSocketChannel	shutdownOutput()
JSSSocket	socket()
Set<SocketOption<?>>	supportedOptions()
int	write(ByteBuffer src)
long	write(ByteBuffer[] srcs, int offset, int length)

Methods inherited from class SocketChannel

open, open, open, read, validOps, write

Methods inherited from class AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class SelectableChannel

register

Methods inherited from class AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class Object

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

Methods inherited from interface Channel

isOpen

Field Details

sslSocket

private JSSSocket sslSocket

parent

private SocketChannel parent

parentSocket

private Socket parentSocket

readChannel

private ReadableByteChannel readChannel

writeChannel

private WritableByteChannel writeChannel

engine

private JSSEngine engine

consumed

private InputStream consumed

consumedChannel

private ReadableByteChannel consumedChannel

autoClose

private boolean autoClose

inboundClosed

private boolean inboundClosed

outboundClosed

private boolean outboundClosed

empty

private ByteBuffer empty

readBuffer

private ByteBuffer readBuffer

writeBuffer

private ByteBuffer writeBuffer

handshakeCompleted

private boolean handshakeCompleted

Constructor Details

JSSSocketChannel

public JSSSocketChannel(JSSSocket sslSocket,
 SocketChannel parent,
 Socket parentSocket,
 ReadableByteChannel readChannel,
 WritableByteChannel writeChannel,
 JSSEngine engine)
                 throws IOException

Throws:

IOException

JSSSocketChannel

public JSSSocketChannel(JSSSocket sslSocket,
 SocketChannel parent,
 JSSEngine engine)
                 throws IOException

Throws:

IOException

JSSSocketChannel

public JSSSocketChannel(JSSSocket sslSocket,
 Socket parentSocket,
 ReadableByteChannel readChannel,
 WritableByteChannel writeChannel,
 JSSEngine engine)
                 throws IOException

Throws:

IOException

Method Details

setConsumedData

public void setConsumedData(InputStream consumed)
                     throws IOException

Give data already consumed by a call to the underlying socket's read method to this Socket, allowing it to be read by the SSLEngine.

Throws:

IOException

setAutoClose

public void setAutoClose(boolean on)

Set whether or not to close the underlying Socket when the SSLSocket or this channel is closed.

remoteRead

private int remoteRead()
                throws IOException

Throws:

IOException

finishConnect

public boolean finishConnect()
                      throws IOException

Specified by:

finishConnect in class SocketChannel

Throws:

IOException

computeSize

private static long computeSize(ByteBuffer[] buffers,
 int offset,
 int length)
                         throws IOException

Compute the total size of a list of buffers from the specified offest and length.

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in class SocketChannel

Throws:

IOException

read

public long read(ByteBuffer[] dsts,
 int offset,
 int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Specified by:

read in class SocketChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface WritableByteChannel

Specified by:

write in class SocketChannel

Throws:

IOException

write

public long write(ByteBuffer[] srcs,
 int offset,
 int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Specified by:

write in class SocketChannel

Throws:

IOException

implCloseSelectableChannel

public void implCloseSelectableChannel()
                                throws IOException

Specified by:

implCloseSelectableChannel in class AbstractSelectableChannel

Throws:

IOException

setListeners

public void setListeners(Collection<? extends EventListener> listeners)

Set the listeners this SSLSocket will fire on certain events.

See Also:

• JSSEngine.setListeners(Collection)

getListeners

public Collection<? extends EventListener> getListeners()

Gets the current list of event listeners this SSLSocket will fire on certain events.

See Also:

• JSSEngine.getListeners()

bind

public JSSSocketChannel bind(SocketAddress local)
                      throws IOException

Specified by:

bind in interface NetworkChannel

Specified by:

bind in class SocketChannel

Throws:

IOException

connect

public boolean connect(SocketAddress remote)
                throws IOException

Specified by:

connect in class SocketChannel

Throws:

IOException

getOption

public <T> T getOption(SocketOption<T> name)
                throws IOException

Throws:

IOException

supportedOptions

public Set<SocketOption<?>> supportedOptions()

setOption

public <T> JSSSocketChannel setOption(SocketOption<T> name,
 T value)
                               throws IOException

Specified by:

setOption in interface NetworkChannel

Specified by:

setOption in class SocketChannel

Throws:

IOException

socket

public JSSSocket socket()

Specified by:

socket in class SocketChannel

isConnected

public boolean isConnected()

Specified by:

isConnected in class SocketChannel

isConnectionPending

public boolean isConnectionPending()

Specified by:

isConnectionPending in class SocketChannel

getLocalAddress

public SocketAddress getLocalAddress()
                              throws IOException

Specified by:

getLocalAddress in interface NetworkChannel

Specified by:

getLocalAddress in class SocketChannel

Throws:

IOException

getRemoteAddress

public SocketAddress getRemoteAddress()
                               throws IOException

Specified by:

getRemoteAddress in class SocketChannel

Throws:

IOException

shutdownInput

public JSSSocketChannel shutdownInput()
                               throws IOException

Specified by:

shutdownInput in class SocketChannel

Throws:

IOException

shutdownOutput

public JSSSocketChannel shutdownOutput()
                                throws IOException

Specified by:

shutdownOutput in class SocketChannel

Throws:

IOException

implConfigureBlocking

public void implConfigureBlocking(boolean block)
                           throws IOException

Specified by:

implConfigureBlocking in class AbstractSelectableChannel

Throws:

IOException