A filter that adds SSL support to the transport.

write(java.nio.ByteBuffer, org.glassfish.tyrus.spi.CompletionHandler) and onRead(java.nio.ByteBuffer) calls are passed through until startSsl() method is called, after which SSL handshake is started. When SSL handshake is in progress, no data passed in write(java.nio.ByteBuffer, org.glassfish.tyrus.spi.CompletionHandler) are permitted until SSL handshake completes. After SSL handshake has completed, all data passed in write method will be encrypted and data passed in onRead(java.nio.ByteBuffer) method will be decrypted.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	SslFilter.LazyBuffer
private static enum	SslFilter.State
private class	SslFilter.WriteQueue

Field Summary

Modifier and Type	Field and Description
private final ByteBuffer	applicationInputBuffer
private final HostnameVerifier	customHostnameVerifier
private static final ByteBuffer	emptyBuffer
private final ByteBuffer	networkOutputBuffer
private Runnable	pendingApplicationWrite
private final String	serverHost
private final SSLEngine	sslEngine
private volatile SslFilter.State	state
private static final String	TLSV13
private volatile boolean	tlsv13
private final SslFilter.WriteQueue	writeQueue

Inherited from org.glassfish.tyrus.container.jdk.client.Filter:: downstreamFilter upstreamFilter

Constructor Summary

Access	Constructor and Description
pack-priv	SslFilter(Filter a filter that is positioned under the SSL filter. downstreamFilter, SslEngineConfigurator configuration of SSL engine. sslEngineConfigurator, String server host (hostname or IP address), which will be used to verify authenticity of the server (the provided host will be compared against the host in the certificate provided by the server). IP address and hostname cannot be used interchangeably - if a certificate contains hostname and an IP address of the server is provided here, the verification will fail. serverHost) SSL Filter constructor, takes upstream filter as a parameter.
pack-priv	SslFilter(Filter a filter that is positioned under the SSL filter. downstreamFilter, SSLContext an SSLContent, usually from @code{ClientEndpointConfig#getSSLContext} sslContext, String server host (hostname or IP address), which will be used to verify authenticity of the server (the provided host will be compared against the host in the certificate provided by the server). IP address and hostname cannot be used interchangeably - if a certificate contains hostname and an IP address of the server is provided here, the verification will fail. serverHost) SSL Filter constructor, takes upstream filter as a parameter.
pack-priv	SslFilter(Filter a filter that is positioned under the SSL filter. downstreamFilter, SslEngineConfigurator sslEngineConfigurator) Deprecated Please use `SslFilter(Filter, org.glassfish.tyrus.client.SslEngineConfigurator, String)`. SSL Filter constructor, takes upstream filter as a parameter.

Method Summary

Modifier and Type	Method and Description
pack-priv synchronized void	close() Overrides org.glassfish.tyrus.container.jdk.client.Filter.close. Close the filter, invokes close operation on the next filter in the filter chain.
private boolean	doHandshakeStep(ByteBuffer networkData)
private String	getDebugState() Returns a printed current state of the SslFilter that could be helpful for troubleshooting.
private void	handleHandshakeFinished()
private synchronized void	handlePostWrite(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)
private boolean	handleRead(ByteBuffer networkData)
private void	handleSslError(Throwable t)
private void	handleWrite(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)
private boolean	isHandshaking(SSLEngineResult.HandshakeStatus hs)
pack-priv boolean	processRead(ByteBuffer read data. networkData) Overrides org.glassfish.tyrus.container.jdk.client.Filter.processRead. Process `onRead(ByteBuffer)`.
pack-priv void	rehandshake() Only for test.
private void	setState(SslFilter.State state)
pack-priv void	startSsl() Overrides org.glassfish.tyrus.container.jdk.client.Filter.startSsl. Signal to turn on SSL, it is passed on in the filter chain until a filter responsible for SSL is reached.
private void	storePendingApplicationWrite(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)
pack-priv synchronized void	write(final ByteBuffer on which write operation is performed. applicationData, final CompletionHandler<ByteBuffer> will be invoked when the write operation is completed or has failed. completionHandler) Overrides org.glassfish.tyrus.container.jdk.client.Filter.write. Perform write operation for this filter and invokes write method on the next filter in the filter chain.

Inherited from org.glassfish.tyrus.container.jdk.client.Filter:: connect handleConnect onConnect onConnectionClosed onError onRead onSslHandshakeCompleted processConnect processConnectionClosed processError processSslHandshakeCompleted

Field Detail

applicationInputBuffer	back to summary
private final ByteBuffer applicationInputBuffer

customHostnameVerifier	back to summary
private final HostnameVerifier customHostnameVerifier

emptyBuffer	back to summary
private static final ByteBuffer emptyBuffer

networkOutputBuffer	back to summary
private final ByteBuffer networkOutputBuffer

pendingApplicationWrite	back to summary
private Runnable pendingApplicationWrite

serverHost	back to summary
private final String serverHost

sslEngine	back to summary
private final SSLEngine sslEngine

state	back to summary
private volatile SslFilter.State state

TLSV13	back to summary
private static final String TLSV13

tlsv13	back to summary
private volatile boolean tlsv13

writeQueue	back to summary
private final SslFilter.WriteQueue writeQueue

Constructor Detail

SslFilter	back to summary
pack-priv SslFilter(Filter downstreamFilter, SslEngineConfigurator sslEngineConfigurator, String serverHost) SSL Filter constructor, takes upstream filter as a parameter. Parameters downstreamFilter:Filter a filter that is positioned under the SSL filter. sslEngineConfigurator:SslEngineConfigurator configuration of SSL engine. serverHost:String server host (hostname or IP address), which will be used to verify authenticity of the server (the provided host will be compared against the host in the certificate provided by the server). IP address and hostname cannot be used interchangeably - if a certificate contains hostname and an IP address of the server is provided here, the verification will fail.

SslFilter

back to summary

pack-priv SslFilter(Filter downstreamFilter, SslEngineConfigurator sslEngineConfigurator, String serverHost)

SSL Filter constructor, takes upstream filter as a parameter.

Parameters

downstreamFilter:Filter: a filter that is positioned under the SSL filter.
sslEngineConfigurator:SslEngineConfigurator: configuration of SSL engine.
serverHost:String: server host (hostname or IP address), which will be used to verify authenticity of the server (the provided host will be compared against the host in the certificate provided by the server). IP address and hostname cannot be used interchangeably - if a certificate contains hostname and an IP address of the server is provided here, the verification will fail.

SslFilter	back to summary
pack-priv SslFilter(Filter downstreamFilter, SSLContext sslContext, String serverHost) SSL Filter constructor, takes upstream filter as a parameter. Parameters downstreamFilter:Filter a filter that is positioned under the SSL filter. sslContext:SSLContext an SSLContent, usually from @code{ClientEndpointConfig#getSSLContext} serverHost:String server host (hostname or IP address), which will be used to verify authenticity of the server (the provided host will be compared against the host in the certificate provided by the server). IP address and hostname cannot be used interchangeably - if a certificate contains hostname and an IP address of the server is provided here, the verification will fail.

SslFilter

back to summary

pack-priv SslFilter(Filter downstreamFilter, SSLContext sslContext, String serverHost)

SSL Filter constructor, takes upstream filter as a parameter.

Parameters

downstreamFilter:Filter: a filter that is positioned under the SSL filter.
sslContext:SSLContext: an SSLContent, usually from @code{ClientEndpointConfig#getSSLContext}
serverHost:String: server host (hostname or IP address), which will be used to verify authenticity of the server (the provided host will be compared against the host in the certificate provided by the server). IP address and hostname cannot be used interchangeably - if a certificate contains hostname and an IP address of the server is provided here, the verification will fail.

SslFilter back to summary

SslFilter	back to summary
pack-priv SslFilter(Filter downstreamFilter, SslEngineConfigurator sslEngineConfigurator) Deprecated Please use `SslFilter(Filter, org.glassfish.tyrus.client.SslEngineConfigurator, String)`. SSL Filter constructor, takes upstream filter as a parameter. Parameters downstreamFilter:Filter a filter that is positioned under the SSL filter.

pack-priv SslFilter(Filter downstreamFilter, SslEngineConfigurator sslEngineConfigurator)

Deprecated

Please use SslFilter(Filter, org.glassfish.tyrus.client.SslEngineConfigurator, String).

SSL Filter constructor, takes upstream filter as a parameter.

Parameters

downstreamFilter:Filter: a filter that is positioned under the SSL filter.

Method Detail

close	back to summary
pack-priv synchronized void close() Overrides org.glassfish.tyrus.container.jdk.client.Filter.close. Doc from org.glassfish.tyrus.container.jdk.client.Filter.close. Close the filter, invokes close operation on the next filter in the filter chain. The filter is expected to clean up any allocated resources and pass the invocation to downstream filter. Annotations @Override

back to summary

pack-priv synchronized void close()

Overrides org.glassfish.tyrus.container.jdk.client.Filter.close.

Doc from org.glassfish.tyrus.container.jdk.client.Filter.close.

Close the filter, invokes close operation on the next filter in the filter chain.

The filter is expected to clean up any allocated resources and pass the invocation to downstream filter.

Annotations

@Override

doHandshakeStep	back to summary
private boolean doHandshakeStep(ByteBuffer networkData)

getDebugState	back to summary
private String getDebugState() Returns a printed current state of the SslFilter that could be helpful for troubleshooting.

handleHandshakeFinished	back to summary
private void handleHandshakeFinished()

handlePostWrite	back to summary
private synchronized void handlePostWrite(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)

handleRead	back to summary
private boolean handleRead(ByteBuffer networkData)

handleSslError	back to summary
private void handleSslError(Throwable t)

handleWrite	back to summary
private void handleWrite(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)

isHandshaking	back to summary
private boolean isHandshaking(SSLEngineResult.HandshakeStatus hs)

processRead back to summary

processRead	back to summary
pack-priv boolean processRead(ByteBuffer networkData) Overrides org.glassfish.tyrus.container.jdk.client.Filter.processRead. Doc from org.glassfish.tyrus.container.jdk.client.Filter.processRead. Process `onRead(ByteBuffer)`. Parameters networkData:ByteBuffer read data. Returns:boolean `true` if the data should be sent to processing to upper filter in the chain, `false` otherwise. Annotations @Override

pack-priv boolean processRead(ByteBuffer networkData)

Overrides org.glassfish.tyrus.container.jdk.client.Filter.processRead.

Doc from org.glassfish.tyrus.container.jdk.client.Filter.processRead.

Process onRead(ByteBuffer).

Parameters

networkData:ByteBuffer: read data.

Returns:boolean

true if the data should be sent to processing to upper filter in the chain, false otherwise.

Annotations

@Override

rehandshake	back to summary
pack-priv void rehandshake() Only for test.

setState	back to summary
private void setState(SslFilter.State state)

startSsl	back to summary
pack-priv void startSsl() Overrides org.glassfish.tyrus.container.jdk.client.Filter.startSsl. Doc from org.glassfish.tyrus.container.jdk.client.Filter.startSsl. Signal to turn on SSL, it is passed on in the filter chain until a filter responsible for SSL is reached. Annotations @Override

startSsl

back to summary

pack-priv void startSsl()

Overrides org.glassfish.tyrus.container.jdk.client.Filter.startSsl.

Doc from org.glassfish.tyrus.container.jdk.client.Filter.startSsl.

Signal to turn on SSL, it is passed on in the filter chain until a filter responsible for SSL is reached.

Annotations

@Override

storePendingApplicationWrite	back to summary
private void storePendingApplicationWrite(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)

write	back to summary
pack-priv synchronized void write(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler) Overrides org.glassfish.tyrus.container.jdk.client.Filter.write. Doc from org.glassfish.tyrus.container.jdk.client.Filter.write. Perform write operation for this filter and invokes write method on the next filter in the filter chain. Parameters applicationData:ByteBuffer on which write operation is performed. completionHandler:CompletionHandler<ByteBuffer> will be invoked when the write operation is completed or has failed. Annotations @Override

write

back to summary

pack-priv synchronized void write(final ByteBuffer applicationData, final CompletionHandler<ByteBuffer> completionHandler)

Overrides org.glassfish.tyrus.container.jdk.client.Filter.write.

Doc from org.glassfish.tyrus.container.jdk.client.Filter.write.

Perform write operation for this filter and invokes write method on the next filter in the filter chain.

Parameters

applicationData:ByteBuffer: on which write operation is performed.
completionHandler:CompletionHandler<ByteBuffer>: will be invoked when the write operation is completed or has failed.

Annotations

@Override

org.glassfish.tyrus.container.jdk.client back to summary

private Class SslFilter.LazyBuffer

Class Inheritance

extends Object

java.lang.Object
org.glassfish.tyrus.container.jdk.client.SslFilter.LazyBuffer

Field Summary

Modifier and Type	Field and Description
private ByteBuffer	buffer

Constructor Summary

Access	Constructor and Description
private	LazyBuffer()

Method Summary

Modifier and Type	Method and Description
pack-priv void	append(ByteBuffer b)
pack-priv ByteBuffer	get()
pack-priv boolean	isAllocated()
pack-priv void	resize()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffer	back to summary
private ByteBuffer buffer

Constructor Detail

LazyBuffer	back to summary
private LazyBuffer()

Method Detail

append	back to summary
pack-priv void append(ByteBuffer b)

get	back to summary
pack-priv ByteBuffer get()

isAllocated	back to summary
pack-priv boolean isAllocated()

resize	back to summary
pack-priv void resize()

org.glassfish.tyrus.container.jdk.client back to summary

private final Enum SslFilter.State

Class Inheritance

extends Enum<SslFilter.State>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.container.jdk.client.SslFilter.State

Field Summary

Modifier and Type	Field and Description
public static final SslFilter.State	CLOSED
public static final SslFilter.State	DATA
public static final SslFilter.State	HANDSHAKING
public static final SslFilter.State	NOT_STARTED
public static final SslFilter.State	REHANDSHAKING

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static SslFilter.State	valueOf(String name)
public static SslFilter.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLOSED	back to summary
public static final SslFilter.State CLOSED

DATA	back to summary
public static final SslFilter.State DATA

HANDSHAKING	back to summary
public static final SslFilter.State HANDSHAKING

NOT_STARTED	back to summary
public static final SslFilter.State NOT_STARTED

REHANDSHAKING	back to summary
public static final SslFilter.State REHANDSHAKING

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static SslFilter.State valueOf(String name)

values	back to summary
public static SslFilter.State[] values()

org.glassfish.tyrus.container.jdk.client back to summary

private Class SslFilter.WriteQueue

Class Inheritance

extends Object

java.lang.Object
org.glassfish.tyrus.container.jdk.client.SslFilter.WriteQueue

Field Summary

Modifier and Type	Field and Description
private final Queue<Runnable>	pendingWrites

Constructor Summary

Access	Constructor and Description
private	WriteQueue()

Method Summary

Modifier and Type	Method and Description
private void	onWriteCompleted()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	write(final ByteBuffer data, final CompletionHandler<ByteBuffer> completionHandler)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

pendingWrites	back to summary
private final Queue<Runnable> pendingWrites

Constructor Detail

WriteQueue	back to summary
private WriteQueue()

Method Detail

onWriteCompleted	back to summary
private void onWriteCompleted()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

write	back to summary
pack-priv void write(final ByteBuffer data, final CompletionHandler<ByteBuffer> completionHandler)

pack-priv Class SslFilter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SslFilter.LazyBuffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum SslFilter.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SslFilter.WriteQueue

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail