org.shared.net.filter.ssl

Class SslFilter

java.lang.Object

org.shared.net.filter.ssl.SslFilter

All Implemented Interfaces:

Filter<ByteBuffer,ByteBuffer>, OobFilter<ByteBuffer,ByteBuffer>

public class SslFilter
extends Object
implements OobFilter<ByteBuffer,ByteBuffer>

An implementation of Filter that encrypts/decrypts traffic using the SSL/TLS protocol.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log The global Logger instance.
protected OobFilter<ByteBuffer,ByteBuffer>	tlsOffFilter The Filter to use when TLS is off.
protected OobFilter<ByteBuffer,ByteBuffer>	tlsOnFilter The Filter to use when TLS is on.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SslFilter(SSLEngine engine, FilteredHandler<?,?,?> handler, Executor executor) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyInbound(Queue<ByteBuffer> inputs, Queue<ByteBuffer> outputs) Filters traffic in the inbound direction.
void	applyInboundOob(Queue<OobEvent> inputs, Queue<OobEvent> outputs) Processes an OobEvent as it would apply to the inbound direction.
void	applyOutbound(Queue<ByteBuffer> inputs, Queue<ByteBuffer> outputs) Filters traffic in the outbound direction.
void	applyOutboundOob(Queue<OobEvent> inputs, Queue<OobEvent> outputs) Processes an OobEvent as it would apply to the outbound direction.
protected static void	debug(String format, Object... args) Logs a debugging message.
protected void	debugHandshakeStatusInbound(SSLEngineResult result) Logs a debugging message based on the current SSLEngineResult.HandshakeStatus for the inbound direction.
protected void	debugHandshakeStatusOutbound(SSLEngineResult result) Logs a debugging message based on the current SSLEngineResult.HandshakeStatus for the outbound direction.
protected void	debugStatusInbound(SSLEngineResult result) Logs a debugging message based on the current SSLEngineResult.Status for the inbound direction.
protected void	debugStatusOutbound(SSLEngineResult result) Logs a debugging message based on the current SSLEngineResult.Status for the outbound direction.
protected void	runDelegatedTasks() Runs delegated tasks.
protected void	setTlsOffFilter() Sets tlsOffFilter.
protected void	setTlsOnFilter() Sets tlsOnFilter.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

The global Logger instance.

tlsOnFilter

protected final OobFilter<ByteBuffer,ByteBuffer> tlsOnFilter

The Filter to use when TLS is on.

tlsOffFilter

protected final OobFilter<ByteBuffer,ByteBuffer> tlsOffFilter

The Filter to use when TLS is off.

Constructor Detail

SslFilter

protected SslFilter(SSLEngine engine,
         FilteredHandler<?,?,?> handler,
         Executor executor)

Default constructor.

Parameters:

engine - the SSLEngine for encryption/decryption of traffic.

handler - the associated FilteredHandler.

executor - the Executor for carrying out delegated tasks.

Method Detail

applyInbound

public void applyInbound(Queue<ByteBuffer> inputs,
                Queue<ByteBuffer> outputs)

Description copied from interface: Filter

Filters traffic in the inbound direction.

Specified by:

applyInbound in interface Filter<ByteBuffer,ByteBuffer>

Parameters:

inputs - the input Queue.

outputs - the output Queue.

applyOutbound

public void applyOutbound(Queue<ByteBuffer> inputs,
                 Queue<ByteBuffer> outputs)

Description copied from interface: Filter

Filters traffic in the outbound direction.

Specified by:

applyOutbound in interface Filter<ByteBuffer,ByteBuffer>

Parameters:

inputs - the input Queue.

outputs - the output Queue.

applyInboundOob

public void applyInboundOob(Queue<OobEvent> inputs,
                   Queue<OobEvent> outputs)

Description copied from interface: OobFilter

Processes an OobEvent as it would apply to the inbound direction.

Specified by:

applyInboundOob in interface OobFilter<ByteBuffer,ByteBuffer>

Parameters:

inputs - the input event Queue.

outputs - the output event Queue.

applyOutboundOob

public void applyOutboundOob(Queue<OobEvent> inputs,
                    Queue<OobEvent> outputs)

Description copied from interface: OobFilter

Processes an OobEvent as it would apply to the outbound direction.

Specified by:

applyOutboundOob in interface OobFilter<ByteBuffer,ByteBuffer>

Parameters:

inputs - the input event Queue.

outputs - the output event Queue.

setTlsOnFilter

protected void setTlsOnFilter()

Sets tlsOnFilter.

setTlsOffFilter

protected void setTlsOffFilter()

Sets tlsOffFilter.

runDelegatedTasks

protected void runDelegatedTasks()

Runs delegated tasks.

debugStatusInbound

protected void debugStatusInbound(SSLEngineResult result)

Logs a debugging message based on the current SSLEngineResult.Status for the inbound direction.

debugHandshakeStatusInbound

protected void debugHandshakeStatusInbound(SSLEngineResult result)

Logs a debugging message based on the current SSLEngineResult.HandshakeStatus for the inbound direction.

debugStatusOutbound

protected void debugStatusOutbound(SSLEngineResult result)

Logs a debugging message based on the current SSLEngineResult.Status for the outbound direction.

debugHandshakeStatusOutbound

protected void debugHandshakeStatusOutbound(SSLEngineResult result)

Logs a debugging message based on the current SSLEngineResult.HandshakeStatus for the outbound direction.

debug

protected static final void debug(String format,
         Object... args)

Logs a debugging message.