org.waarp.common.crypto.ssl

Class WaarpSslUtility

java.lang.Object

org.waarp.common.crypto.ssl.WaarpSslUtility

public final class WaarpSslUtility
extends Object

Utilities for SSL support

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.channel.ChannelFutureListener	SSLCLOSE Closing channel with SSL close at first step

Method Summary

Modifier and Type	Method and Description
static void	addSslHandler(io.netty.channel.ChannelFuture future, io.netty.channel.ChannelPipeline pipeline, io.netty.channel.ChannelHandler sslHandler, io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super io.netty.channel.Channel>> listener) Add a SslHandler in a pipeline when the channel is already active
static void	addSslOpenedChannel(io.netty.channel.Channel channel) Add the Channel as SSL handshake will start soon
static io.netty.channel.ChannelFuture	closingSslChannel(io.netty.channel.Channel channel) Utility method to close a channel in SSL mode correctly (if any)
static void	forceCloseAllSslChannels() Utility to force all channels to be closed
static void	removingSslHandler(io.netty.channel.ChannelFuture future, io.netty.channel.Channel channel, boolean close) Remove the SslHandler (if any) cleanly
static io.netty.channel.Channel	waitforChannelReady(io.netty.channel.ChannelFuture future) Waiting for the channel to be opened and ready (Client side) (blocking call)
static boolean	waitForClosingSslChannel(io.netty.channel.Channel channel, long delay) Wait for the channel with SSL to be closed
static boolean	waitForHandshake(io.netty.channel.Channel channel) Wait for the handshake on the given channel (better to use addSslHandler when handler is added after channel is active)

Methods inherited from class java.lang.Object

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

Field Detail

SSLCLOSE

public static final io.netty.channel.ChannelFutureListener SSLCLOSE

Closing channel with SSL close at first step

Method Detail

addSslOpenedChannel

public static void addSslOpenedChannel(io.netty.channel.Channel channel)

Add the Channel as SSL handshake will start soon

Parameters:

channel -

addSslHandler

public static void addSslHandler(io.netty.channel.ChannelFuture future,
                                 io.netty.channel.ChannelPipeline pipeline,
                                 io.netty.channel.ChannelHandler sslHandler,
                                 io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super io.netty.channel.Channel>> listener)

Add a SslHandler in a pipeline when the channel is already active

Parameters:

future - might be null, condition to start to add the handler to the pipeline

pipeline -

sslHandler -

listener - action once the handshake is done

waitForHandshake

public static boolean waitForHandshake(io.netty.channel.Channel channel)

Wait for the handshake on the given channel (better to use addSslHandler when handler is added after channel is active)

Parameters:

channel -

Returns:

True if the Handshake is done correctly

waitforChannelReady

public static io.netty.channel.Channel waitforChannelReady(io.netty.channel.ChannelFuture future)

Waiting for the channel to be opened and ready (Client side) (blocking call)

Parameters:

future - a future on connect only

Returns:

the channel if correctly associated, else return null

forceCloseAllSslChannels

public static void forceCloseAllSslChannels()

Utility to force all channels to be closed

closingSslChannel

public static io.netty.channel.ChannelFuture closingSslChannel(io.netty.channel.Channel channel)

Utility method to close a channel in SSL mode correctly (if any)

Parameters:

channel -

removingSslHandler

public static void removingSslHandler(io.netty.channel.ChannelFuture future,
                                      io.netty.channel.Channel channel,
                                      boolean close)

Remove the SslHandler (if any) cleanly

Parameters:

future - if not null, wait for this future to be done to removed the sslhandler

channel -

close - True to close the channel, else to only remove it

waitForClosingSslChannel

public static boolean waitForClosingSslChannel(io.netty.channel.Channel channel,
                                               long delay)

Wait for the channel with SSL to be closed

Parameters:

channel -

delay -

Returns:

True if an error occurs as an interruption