org.restlet.ext.nio

Class HttpsClientHelper

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.RestletHelper<T>

org.restlet.engine.connector.ConnectorHelper<T>

org.restlet.ext.nio.BaseHelper<T>

org.restlet.ext.nio.ConnectionHelper<Client>

org.restlet.ext.nio.ClientConnectionHelper

org.restlet.ext.nio.HttpsClientHelper

public class HttpsClientHelper
extends ClientConnectionHelper

HTTPS client helper based on NIO blocking sockets. Here is the list of SSL related parameters that are also supported:

Parameter name	Value type	Default value	Description
sslContextFactory	String	org.restlet.engine.ssl.DefaultSslContextFactory	Let you specify a SslContextFactory qualified class name as a parameter, or an instance as an attribute for a more complete and flexible SSL context setting.

For the default SSL parameters see the Javadocs of the DefaultSslContextFactory class.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.ext.nio.ClientConnectionHelper

CONNECTOR_LATCH

Fields inherited from class org.restlet.ext.nio.BaseHelper

clientSide, controller, inboundMessages, outboundMessages

Constructor Summary

Constructors

Constructor and Description
HttpsClientHelper(Client client) Constructor.

Method Summary

Modifier and Type	Method and Description
Connection<Client>	createConnection(SocketChannel socketChannel, ConnectionController controller, InetSocketAddress socketAddress) Creates a connection associated to the given socket.
InboundWay	createInboundWay(Connection<Client> connection, int bufferSize) Creates an inbound way for the given connection.
OutboundWay	createOutboundWay(Connection<Client> connection, int bufferSize) Creates an outbound way for the given connection.
protected SSLContext	getSslContext() Returns the SSL context.
protected void	setSslContext(SSLContext sslContext) Sets the SSL context.
void	start() Start callback.

Methods inherited from class org.restlet.ext.nio.ClientConnectionHelper

createController, createSocketChannel, createSocketChannel, doHandleInbound, doHandleOutbound, getBestConnection, getProxyHost, getProxyPort, getSocketAddress, getSocketConnectTimeoutMs, handle, handleInbound, handleOutbound, isControllerDaemon, isProxying, stop, unblock

Methods inherited from class org.restlet.ext.nio.ConnectionHelper

addOutboundMessage, checkin, checkout, configure, createConnectionPool, doFinishStop, doGracefulStop, getConnectionPool, getConnections, getInitialConnections, getMaxConnectionsPerHost, getMaxTotalConnections, getSocketLingerTimeMs, getSocketReceiveBufferSize, getSocketSendBufferSize, getSocketTrafficClass, isPersistingConnections, isPipeliningConnections, isPooledConnection, isSocketKeepAlive, isSocketNoDelay, isSocketOobInline, isSocketReuseAddress

Methods inherited from class org.restlet.ext.nio.BaseHelper

control, createControllerService, createRequest, createWorkerService, execute, getController, getControllerSleepTimeMs, getInboundBufferSize, getInboundMessages, getLowThreads, getMaxIoIdleTimeMs, getMaxQueued, getMaxThreadIdleTimeMs, getMaxThreads, getMinThreads, getOutboundBufferSize, getOutboundMessages, getRequest, getThrottleTimeMs, getTraceStream, getTransport, getWorkerService, handleInbound, handleOutbound, hasWorkerThreads, isClientSide, isDirectBuffers, isServerSide, isTracing, isWorkerServiceOverloaded, onInboundError, onOutboundError, traceWorkerService

Methods inherited from class org.restlet.engine.connector.ConnectorHelper

getConnectorService, getContext, getProtocols, update

Methods inherited from class org.restlet.engine.RestletHelper

getAttributes, getHelped, getHelpedParameters, getLogger, getMetadataService, setHelped

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpsClientHelper

public HttpsClientHelper(Client client)

Constructor.

Parameters:

client - The client to help.

Method Detail

createConnection

public Connection<Client> createConnection(SocketChannel socketChannel,
                                           ConnectionController controller,
                                           InetSocketAddress socketAddress)
                                    throws IOException

Description copied from class: ConnectionHelper

Creates a connection associated to the given socket.

Overrides:

createConnection in class ClientConnectionHelper

Parameters:

socketChannel - The underlying NIO socket channel.

controller - The underlying IO controller.

socketAddress - The associated IP address.

Returns:

The new connection.

Throws:

IOException

createInboundWay

public InboundWay createInboundWay(Connection<Client> connection,
                                   int bufferSize)

Description copied from class: ConnectionHelper

Creates an inbound way for the given connection.

Specified by:

createInboundWay in class ConnectionHelper<Client>

Parameters:

connection - The parent connection.

bufferSize - The byte buffer size.

Returns:

The inbound way created.

createOutboundWay

public OutboundWay createOutboundWay(Connection<Client> connection,
                                     int bufferSize)

Description copied from class: ConnectionHelper

Creates an outbound way for the given connection.

Specified by:

createOutboundWay in class ConnectionHelper<Client>

Parameters:

connection - The parent connection.

bufferSize - The byte buffer size.

Returns:

The outbound way created.

getSslContext

protected SSLContext getSslContext()

Returns the SSL context.

Returns:

The SSL context.

setSslContext

protected void setSslContext(SSLContext sslContext)

Sets the SSL context.

Parameters:

sslContext - The SSL context.

start

public void start()
           throws Exception

Description copied from class: RestletHelper

Start callback.

Overrides:

start in class ClientConnectionHelper

Throws:

Exception