Modifier and Type	Class and Description
private class	SSLFilter.ConnectionCloseListener References Deprecated `GenericCloseListener` is deprecated or references (maybe indirectly) at least one deprecated element. Close listener, which is used to notify handshake completion handler about failure, if `Connection` will be unexpectedly closed.
private static class	SSLFilter.HostNameResolver The static class is used as JDK 1.7+ guard and shouldn't be initialized by JDK 1.6.x at runtime, because one of the methods is only available since 1.7.
private class	SSLFilter.SSLHandshakeContext

Modifier and Type	Field and Description
private final SSLEngineConfigurator	clientSSLEngineConfigurator
private final SSLFilter.ConnectionCloseListener	closeListener References Deprecated `SSLFilter.ConnectionCloseListener` is deprecated or references (maybe indirectly) at least one deprecated element.
private final Attribute<SSLFilter.SSLHandshakeContext>	handshakeContextAttr
private static final Logger	LOGGER Hides org.glassfish.grizzly.ssl.SSLBaseFilter.LOGGER.
protected volatile int	maxPendingBytes

Constructor Summary

Access	Constructor and Description
public	SSLFilter()
public	SSLFilter(SSLEngineConfigurator SSLEngine configurator for server side connections serverSSLEngineConfigurator, SSLEngineConfigurator SSLEngine configurator for client side connections clientSSLEngineConfigurator) Build `SSLFilter` with the given `SSLEngineConfigurator`.
public	SSLFilter(SSLEngineConfigurator SSLEngine configurator for server side connections serverSSLEngineConfigurator, SSLEngineConfigurator SSLEngine configurator for client side connections clientSSLEngineConfigurator, boolean `true`, if SSLBaseFilter has to force client authentication during re-handshake, in case the client didn't send its credentials during the initial handshake in response to "wantClientAuth" flag. In this case "needClientAuth" flag will be raised and re-handshake will be initiated renegotiateOnClientAuthWant) Build `SSLFilter` with the given `SSLEngineConfigurator`.

Method Summary

Modifier and Type	Method and Description
private NextAction	accurateWrite(final FilterChainContext ctx, final boolean isHandshakeComplete) Has to be called in synchronized(connection) {...} block.
protected SSLEngine	createClientSSLEngine(final SSLConnectionContext sslCtx, final SSLEngineConfigurator sslEngineConfigurator)
protected Buffer	doHandshakeStep(final SSLConnectionContext sslCtx, final FilterChainContext ctx, final Buffer inputBuffer, final Buffer tmpAppBuffer0) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.doHandshakeStep.
public SSLEngineConfigurator	getClientSSLEngineConfigurator() Returns: `SSLEngineConfigurator` used by the filter to create new `SSLEngine` for client-side `Connection`s
public int	getMaxPendingBytesPerConnection() Returns: the maximum number of bytes that may be queued to be written to a particular `Connection`.
public NextAction	handleWrite(final FilterChainContext ctx) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.handleWrite. Implements org.glassfish.grizzly.filterchain.Filter.handleWrite. Execute a unit of processing work to be performed, when some data should be written on channel.
public void	handshake(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler)
public void	handshake(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler, final Object dstAddress)
public void	handshake(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler, final Object dstAddress, final SSLEngineConfigurator sslEngineConfigurator)
protected void	handshake(final Connection<?> connection, final CompletionHandler<SSLEngine> completionHandler, final Object dstAddress, final SSLEngineConfigurator sslEngineConfigurator, final FilterChainContext context, final boolean forceBeginHandshake)
protected void	notifyHandshakeComplete(final Connection<?> connection, final SSLEngine sslEngine) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.notifyHandshakeComplete.
protected void	notifyHandshakeFailed(Connection<L> connection, Throwable t) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.notifyHandshakeFailed.
public void	setMaxPendingBytesPerConnection(final int maximum number of bytes that may be queued to be written for a particular `Connection` maxPendingBytes) Configures the maximum number of bytes that may be queued to be written for a particular `Connection`.

Field Detail

clientSSLEngineConfigurator	back to summary
private final SSLEngineConfigurator clientSSLEngineConfigurator

closeListener	back to summary
private final SSLFilter.ConnectionCloseListener closeListener References Deprecated `SSLFilter.ConnectionCloseListener` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

handshakeContextAttr	back to summary
private final Attribute<SSLFilter.SSLHandshakeContext> handshakeContextAttr

LOGGER	back to summary
private static final Logger LOGGER Hides org.glassfish.grizzly.ssl.SSLBaseFilter.LOGGER.

maxPendingBytes	back to summary
protected volatile int maxPendingBytes

Constructor Detail

SSLFilter	back to summary
public SSLFilter()

SSLFilter back to summary

SSLFilter	back to summary
public SSLFilter(SSLEngineConfigurator serverSSLEngineConfigurator, SSLEngineConfigurator clientSSLEngineConfigurator) Build `SSLFilter` with the given `SSLEngineConfigurator`. Parameters serverSSLEngineConfigurator:SSLEngineConfigurator SSLEngine configurator for server side connections clientSSLEngineConfigurator:SSLEngineConfigurator SSLEngine configurator for client side connections

public SSLFilter(SSLEngineConfigurator serverSSLEngineConfigurator, SSLEngineConfigurator clientSSLEngineConfigurator)

Build SSLFilter with the given SSLEngineConfigurator.

Parameters

serverSSLEngineConfigurator:SSLEngineConfigurator: SSLEngine configurator for server side connections
clientSSLEngineConfigurator:SSLEngineConfigurator: SSLEngine configurator for client side connections

SSLFilter back to summary

SSLFilter	back to summary
public SSLFilter(SSLEngineConfigurator serverSSLEngineConfigurator, SSLEngineConfigurator clientSSLEngineConfigurator, boolean renegotiateOnClientAuthWant) Build `SSLFilter` with the given `SSLEngineConfigurator`. Parameters serverSSLEngineConfigurator:SSLEngineConfigurator SSLEngine configurator for server side connections clientSSLEngineConfigurator:SSLEngineConfigurator SSLEngine configurator for client side connections renegotiateOnClientAuthWant:boolean `true`, if SSLBaseFilter has to force client authentication during re-handshake, in case the client didn't send its credentials during the initial handshake in response to "wantClientAuth" flag. In this case "needClientAuth" flag will be raised and re-handshake will be initiated

public SSLFilter(SSLEngineConfigurator serverSSLEngineConfigurator, SSLEngineConfigurator clientSSLEngineConfigurator, boolean renegotiateOnClientAuthWant)

Build SSLFilter with the given SSLEngineConfigurator.

Parameters

serverSSLEngineConfigurator:SSLEngineConfigurator: SSLEngine configurator for server side connections
clientSSLEngineConfigurator:SSLEngineConfigurator: SSLEngine configurator for client side connections
renegotiateOnClientAuthWant:boolean: true, if SSLBaseFilter has to force client authentication during re-handshake, in case the client didn't send its credentials during the initial handshake in response to "wantClientAuth" flag. In this case "needClientAuth" flag will be raised and re-handshake will be initiated

Method Detail

accurateWrite	back to summary
private NextAction accurateWrite(final FilterChainContext ctx, final boolean isHandshakeComplete) throws IOException Has to be called in synchronized(connection) {...} block.

createClientSSLEngine	back to summary
protected SSLEngine createClientSSLEngine(final SSLConnectionContext sslCtx, final SSLEngineConfigurator sslEngineConfigurator)

doHandshakeStep	back to summary
protected Buffer doHandshakeStep(final SSLConnectionContext sslCtx, final FilterChainContext ctx, final Buffer inputBuffer, final Buffer tmpAppBuffer0) throws IOException Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.doHandshakeStep. Annotations @Override

doHandshakeStep

back to summary

protected Buffer doHandshakeStep(final SSLConnectionContext sslCtx, final FilterChainContext ctx, final Buffer inputBuffer, final Buffer tmpAppBuffer0) throws IOException

Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.doHandshakeStep.

Annotations

@Override

getClientSSLEngineConfigurator	back to summary
public SSLEngineConfigurator getClientSSLEngineConfigurator() Returns:SSLEngineConfigurator `SSLEngineConfigurator` used by the filter to create new `SSLEngine` for client-side `Connection`s

getMaxPendingBytesPerConnection	back to summary
public int getMaxPendingBytesPerConnection() Returns:int the maximum number of bytes that may be queued to be written to a particular `Connection`. This value is related to the situation when we try to send application data before SSL handshake completes, so the data should be stored and sent on wire once handshake will be completed.

handleWrite back to summary

handleWrite	back to summary
public NextAction handleWrite(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.handleWrite. Implements org.glassfish.grizzly.filterchain.Filter.handleWrite. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleWrite. Execute a unit of processing work to be performed, when some data should be written on channel. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override

public NextAction handleWrite(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.handleWrite.

Implements org.glassfish.grizzly.filterchain.Filter.handleWrite.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleWrite.

Execute a unit of processing work to be performed, when some data should be written on channel. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override

handshake	back to summary
public void handshake(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler) throws IOException

handshake	back to summary
public void handshake(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler, final Object dstAddress) throws IOException

handshake	back to summary
public void handshake(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler, final Object dstAddress, final SSLEngineConfigurator sslEngineConfigurator) throws IOException

handshake	back to summary
protected void handshake(final Connection<?> connection, final CompletionHandler<SSLEngine> completionHandler, final Object dstAddress, final SSLEngineConfigurator sslEngineConfigurator, final FilterChainContext context, final boolean forceBeginHandshake) throws IOException

notifyHandshakeComplete	back to summary
protected void notifyHandshakeComplete(final Connection<?> connection, final SSLEngine sslEngine) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.notifyHandshakeComplete. Annotations @Override

notifyHandshakeComplete

back to summary

protected void notifyHandshakeComplete(final Connection<?> connection, final SSLEngine sslEngine)

Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.notifyHandshakeComplete.

Annotations

@Override

notifyHandshakeFailed	back to summary
protected void notifyHandshakeFailed(Connection<L> connection, Throwable t) Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.notifyHandshakeFailed. Annotations @Override

notifyHandshakeFailed

back to summary

protected void notifyHandshakeFailed(Connection<L> connection, Throwable t)

Overrides org.glassfish.grizzly.ssl.SSLBaseFilter.notifyHandshakeFailed.

Annotations

@Override

setMaxPendingBytesPerConnection back to summary

setMaxPendingBytesPerConnection	back to summary
public void setMaxPendingBytesPerConnection(final int maxPendingBytes) Configures the maximum number of bytes that may be queued to be written for a particular `Connection`. This value is related to the situation when we try to send application data before SSL handshake completes, so the data should be stored and sent on wire once handshake will be completed. Parameters maxPendingBytes:int maximum number of bytes that may be queued to be written for a particular `Connection`

public void setMaxPendingBytesPerConnection(final int maxPendingBytes)

Configures the maximum number of bytes that may be queued to be written for a particular Connection. This value is related to the situation when we try to send application data before SSL handshake completes, so the data should be stored and sent on wire once handshake will be completed.

Parameters

maxPendingBytes:int: maximum number of bytes that may be queued to be written for a particular Connection

org.glassfish.grizzly.ssl back to summary

private final Class SSLFilter.ConnectionCloseListener

Class Inheritance

extends Object
implements GenericCloseListener

java.lang.Object
org.glassfish.grizzly.ssl.SSLFilter.ConnectionCloseListener

All Implemented Interfaces

org.glassfish.grizzly.GenericCloseListener, org.glassfish.grizzly.CloseListener

References Deprecated

GenericCloseListener is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Close listener, which is used to notify handshake completion handler about failure, if Connection will be unexpectedly closed.

Constructor Summary

Access	Constructor and Description
private	ConnectionCloseListener()

Method Summary

Modifier and Type	Method and Description
public void	onClosed(final Closeable closeable, final CloseType type) Implements org.glassfish.grizzly.CloseListener.onClosed. References Deprecated `CloseType` is deprecated or references (maybe indirectly) at least one deprecated element.

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

Constructor Detail

ConnectionCloseListener	back to summary
private ConnectionCloseListener()

Method Detail

onClosed back to summary

onClosed	back to summary
public void onClosed(final Closeable closeable, final CloseType type) throws IOException Implements org.glassfish.grizzly.CloseListener.onClosed. References Deprecated `CloseType` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Annotations @Override

public void onClosed(final Closeable closeable, final CloseType type) throws IOException

Implements org.glassfish.grizzly.CloseListener.onClosed.

References Deprecated

CloseType is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Annotations

@Override

org.glassfish.grizzly.ssl back to summary

private Class SSLFilter.HostNameResolver

Class Inheritance

extends Object

java.lang.Object
org.glassfish.grizzly.ssl.SSLFilter.HostNameResolver

The static class is used as JDK 1.7+ guard and shouldn't be initialized by JDK 1.6.x at runtime, because one of the methods is only available since 1.7.

Constructor Summary

Access	Constructor and Description
private	HostNameResolver()

Method Summary

Modifier and Type	Method and Description
public static String	getPeerHostName(final Connection<?> connection)

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

Constructor Detail

HostNameResolver	back to summary
private HostNameResolver()

Method Detail

getPeerHostName	back to summary
public static String getPeerHostName(final Connection<?> connection)

org.glassfish.grizzly.ssl back to summary

private final Class SSLFilter.SSLHandshakeContext

Class Inheritance

extends Object

java.lang.Object
org.glassfish.grizzly.ssl.SSLFilter.SSLHandshakeContext

Field Summary

Modifier and Type	Field and Description
private CompletionHandler<SSLEngine>	completionHandler
private final Connection<L>	connection
private Throwable	error
private boolean	isComplete
private List<FilterChainContext>	pendingWriteContexts
private int	sizeInBytes

Constructor Summary

Access	Constructor and Description
public	SSLHandshakeContext(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler)

Method Summary

Modifier and Type	Method and Description
public boolean	add(FilterChainContext context) Has to be called in synchronized(connection) {...} scope.
public void	completed(final SSLEngine engine)
public void	failed(final Throwable throwable)
private void	resumePendingWrites()

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

Field Detail

completionHandler	back to summary
private CompletionHandler<SSLEngine> completionHandler

connection	back to summary
private final Connection<L> connection

error	back to summary
private Throwable error

isComplete	back to summary
private boolean isComplete

pendingWriteContexts	back to summary
private List<FilterChainContext> pendingWriteContexts

sizeInBytes	back to summary
private int sizeInBytes

Constructor Detail

SSLHandshakeContext	back to summary
public SSLHandshakeContext(final Connection<L> connection, final CompletionHandler<SSLEngine> completionHandler)

Method Detail

add	back to summary
public boolean add(FilterChainContext context) throws IOException Has to be called in synchronized(connection) {...} scope.

completed	back to summary
public void completed(final SSLEngine engine)

failed	back to summary
public void failed(final Throwable throwable)

resumePendingWrites	back to summary
private void resumePendingWrites()

public Class SSLFilter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SSLFilter.ConnectionCloseListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class SSLFilter.HostNameResolver

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class SSLFilter.SSLHandshakeContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail