Package org.jenkinsci.remoting.protocol.impl

Class SSLEngineFilterLayer

java.lang.Object

org.jenkinsci.remoting.protocol.FilterLayer

org.jenkinsci.remoting.protocol.impl.SSLEngineFilterLayer

All Implemented Interfaces:

ProtocolLayer, ProtocolLayer.Recv, ProtocolLayer.Send

public class SSLEngineFilterLayer
extends FilterLayer

A FilterLayer that encrypts the communication between the upper layers and the lower layers using the supplied SSLEngine.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SSLEngineFilterLayer.Listener	A listener for the connection headers.

Nested classes/interfaces inherited from interface org.jenkinsci.remoting.protocol.ProtocolLayer

ProtocolLayer.Recv, ProtocolLayer.Send

Field Summary

Fields inherited from interface org.jenkinsci.remoting.protocol.ProtocolLayer

EMPTY_BUFFER

Constructor Summary

Constructors

Constructor	Description
SSLEngineFilterLayer(SSLEngine engine, SSLEngineFilterLayer.Listener listener)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	doCloseSend()	Notify the lower layer that it should close.
void	doSend(ByteBuffer message)	SPI: Sends data to the lower layer.
boolean	isRecvOpen()	Tracks if this layer is accepting received data via ProtocolLayer.Recv.onRecv(ByteBuffer).
boolean	isSendOpen()	Tracks if this layer is submitting data to be sent via ProtocolLayer.Send.doSend(ByteBuffer).
void	onRecv(ByteBuffer readBuffer)	SPI: Callback on data being received from the lower layer.
void	onRecvClosed(IOException cause)	Callback on the lower layer's source of data being closed.
void	start()	Starts this layer.

Methods inherited from class org.jenkinsci.remoting.protocol.FilterLayer

abort, completed, flushRecv, flushSend, init, next, stack

Methods inherited from class java.lang.Object

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

Constructor Details

SSLEngineFilterLayer

public SSLEngineFilterLayer(@NonNull
 SSLEngine engine,
 @CheckForNull
 SSLEngineFilterLayer.Listener listener)

Constructs a new instance.

Parameters:

engine - the engine to use.

listener - the listener to notify when handshaking is completed.

Method Details

start

public void start()
           throws IOException

Starts this layer. All layers in the stack will be initialized before a call to this method. All lower layers in the stack will have been started before this layer is started.

Specified by:

start in interface ProtocolLayer

Overrides:

start in class FilterLayer

Throws:

IOException - if something goes wrong.

onRecv

public void onRecv(@NonNull
 ByteBuffer readBuffer)
            throws IOException

SPI: Callback on data being received from the lower layer.

Specified by:

onRecv in interface ProtocolLayer.Recv

Specified by:

onRecv in class FilterLayer

Parameters:

readBuffer - the data received. Any data consumed from the ByteBuffer can be assumed as processed. Any data not consumed from the ByteBuffer will be the responsibility of the caller to resubmit in subsequent calls.

Throws:

IOException - if there was an error during processing of the received data.

onRecvClosed

public void onRecvClosed(IOException cause)
                  throws IOException

Callback on the lower layer's source of data being closed.

Specified by:

onRecvClosed in interface ProtocolLayer.Recv

Overrides:

onRecvClosed in class FilterLayer

Parameters:

cause - the cause of the lower layer being closed or null.

Throws:

IOException - if there was an error during the processing of the close notification.

isRecvOpen

public boolean isRecvOpen()

Tracks if this layer is accepting received data via ProtocolLayer.Recv.onRecv(ByteBuffer). Once this method returns false it must always return false and can be assumed to behave in this way.

Specified by:

isRecvOpen in interface ProtocolLayer.Recv

Overrides:

isRecvOpen in class FilterLayer

Returns:

true if accepting received data via ProtocolLayer.Recv.onRecv(ByteBuffer).

doSend

public void doSend(@NonNull
 ByteBuffer message)
            throws IOException

SPI: Sends data to the lower layer.

Specified by:

doSend in interface ProtocolLayer.Send

Specified by:

doSend in class FilterLayer

Parameters:

message - the data to send. Any data consumed from the ByteBuffer can be assumed as processed. Any data not consumed from the ByteBuffer will be the responsibility of the caller to resubmit in subsequent calls.

Throws:

IOException - if there was an error during processing of the data.

doCloseSend

public void doCloseSend()
                 throws IOException

Notify the lower layer that it should close. Callers to this method are assumed to have already called ProtocolLayer.Recv.onRecvClosed(IOException) for any upper layers.

Specified by:

doCloseSend in interface ProtocolLayer.Send

Overrides:

doCloseSend in class FilterLayer

Throws:

IOException - if there was an error closing the lower layer.

isSendOpen

public boolean isSendOpen()

Tracks if this layer is submitting data to be sent via ProtocolLayer.Send.doSend(ByteBuffer). Once this method returns false it must always return false and can be assumed to behave in this way.

Specified by:

isSendOpen in interface ProtocolLayer.Send

Overrides:

isSendOpen in class FilterLayer

Returns:

true if submitting data to be sent via ProtocolLayer.Send.doSend(ByteBuffer).