org.restlet.ext.ssl

Class HttpsServerHelper

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.RestletHelper<T>

org.restlet.engine.ConnectorHelper<T>

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

org.restlet.engine.connector.ConnectionHelper<Server>

org.restlet.engine.connector.ServerConnectionHelper

org.restlet.engine.connector.HttpServerHelper

org.restlet.ext.ssl.HttpsServerHelper

public class HttpsServerHelper
extends HttpServerHelper

HTTPS server 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.ext.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.engine.connector.BaseHelper

clientSide, controller, inboundMessages, outboundMessages

Constructor Summary

Constructors

Constructor and Description
HttpsServerHelper(Server server) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Connection<Server>	createConnection(SocketChannel socketChannel, ConnectionController controller, InetSocketAddress socketAddress) Creates a connection associated to the given socket.
InboundWay	createInboundWay(Connection<Server> connection, int bufferSize) Creates an inbound way for the given connection.
OutboundWay	createOutboundWay(Connection<Server> connection, int bufferSize) Creates an outbound way for the given connection.
protected Request	createRequest(Connection<Server> connection, String methodName, String resourceUri, String protocol) Creates a new request.
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.engine.connector.HttpServerHelper

canHandle

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

createController, createServerSocketChannel, createSocketAddress, doHandleInbound, doHandleOutbound, getController, getServerSocketChannel, handle, handleInbound, handleOutbound, isControllerDaemon, isProxying, isReuseAddress, setEphemeralPort, setEphemeralPort, stop

Methods inherited from class org.restlet.engine.connector.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.engine.connector.BaseHelper

control, createControllerService, createRequest, createWorkerService, execute, 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.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

HttpsServerHelper

public HttpsServerHelper(Server server)

Constructor.

Parameters:

server - The server to help.

Method Detail

createConnection

protected Connection<Server> 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 ServerConnectionHelper

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<Server> connection,
                                   int bufferSize)

Description copied from class: ConnectionHelper

Creates an inbound way for the given connection.

Overrides:

createInboundWay in class HttpServerHelper

Parameters:

connection - The parent connection.

bufferSize - The byte buffer size.

Returns:

The inbound way created.

createOutboundWay

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

Description copied from class: ConnectionHelper

Creates an outbound way for the given connection.

Overrides:

createOutboundWay in class HttpServerHelper

Parameters:

connection - The parent connection.

bufferSize - The byte buffer size.

Returns:

The outbound way created.

createRequest

protected Request createRequest(Connection<Server> connection,
                                String methodName,
                                String resourceUri,
                                String protocol)

Description copied from class: ServerConnectionHelper

Creates a new request.

Overrides:

createRequest in class HttpServerHelper

Parameters:

connection - The associated connection.

methodName - The method name.

resourceUri - The target resource URI.

protocol - The protocol name and version.

Returns:

The created request.

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 ServerConnectionHelper

Throws:

Exception