net.officefloor.plugin.socket.server.ssl.protocol

Class SslCommunicationProtocol

java.lang.Object

net.officefloor.plugin.socket.server.ssl.protocol.SslCommunicationProtocol

All Implemented Interfaces:

CommunicationProtocol, CommunicationProtocolSource, SslTaskExecutor

public class SslCommunicationProtocol
extends Object
implements CommunicationProtocolSource, CommunicationProtocol, SslTaskExecutor

SSL CommunicationProtocolSource that wraps another CommunicationProtocolSource.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_SSL_ENGINE_SOURCE Property to obtain the optional SslEngineSource to provide the SSLEngine instances.

Constructor Summary

Constructors

Constructor and Description
SslCommunicationProtocol(CommunicationProtocolSource wrappedCommunicationProtocolSource) Initiate.

Method Summary

Modifier and Type	Method and Description
void	beginTask(Runnable task) Begins executing the SSL task.
CommunicationProtocol	createCommunicationProtocol(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> configurationContext, CommunicationProtocolContext protocolContext) Creates the CommunicationProtocol.
SslConnectionHandler	createConnectionHandler(Connection connection) Creates a ConnectionHandler for a new Connection.
void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Loads any specifications for this communication protocol.
void	setManagedObjectExecuteContext(ManagedObjectExecuteContext<Indexed> executeContext) Provides the CommunicationProtocol the ManagedObjectExecuteContext to enable it to invoke ProcessState instances to process input.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SSL_ENGINE_SOURCE

public static final String PROPERTY_SSL_ENGINE_SOURCE

Property to obtain the optional SslEngineSource to provide the SSLEngine instances.

See Also:

Constant Field Values

Constructor Detail

SslCommunicationProtocol

public SslCommunicationProtocol(CommunicationProtocolSource wrappedCommunicationProtocolSource)

Initiate.

Parameters:

wrappedCommunicationProtocolSource - CommunicationProtocolSource to be wrapped with this SSL CommunicationProtocolSource.

Method Detail

loadSpecification

public void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from interface: CommunicationProtocolSource

Loads any specifications for this communication protocol.

Specified by:

loadSpecification in interface CommunicationProtocolSource

Parameters:

context - AbstractAsyncManagedObjectSource.SpecificationContext.

createCommunicationProtocol

public CommunicationProtocol createCommunicationProtocol(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> configurationContext,
                                                         CommunicationProtocolContext protocolContext)
                                                  throws Exception

Description copied from interface: CommunicationProtocolSource

Creates the CommunicationProtocol.

Specified by:

createCommunicationProtocol in interface CommunicationProtocolSource

Parameters:

configurationContext - AbstractAsyncManagedObjectSource.MetaDataContext.

protocolContext - CommunicationProtocolSource.

Returns:

CommunicationProtocol.

Throws:

Exception - If fails to create the CommunicationProtocol.

setManagedObjectExecuteContext

public void setManagedObjectExecuteContext(ManagedObjectExecuteContext<Indexed> executeContext)

Description copied from interface: CommunicationProtocol

Provides the CommunicationProtocol the ManagedObjectExecuteContext to enable it to invoke ProcessState instances to process input.

Specified by:

setManagedObjectExecuteContext in interface CommunicationProtocol

Parameters:

executeContext - ManagedObjectExecuteContext.

createConnectionHandler

public SslConnectionHandler createConnectionHandler(Connection connection)

Description copied from interface: CommunicationProtocol

Creates a ConnectionHandler for a new Connection.

Specified by:

createConnectionHandler in interface CommunicationProtocol

Parameters:

connection - A new Connection requiring handling.

Returns:

ConnectionHandler to handle the new Connection.

beginTask

public void beginTask(Runnable task)

Description copied from interface: SslTaskExecutor

Begins executing the SSL task.

As this method likely passes the Runnable to another Thread this method will generally return before the Runnable is complete.

Specified by:

beginTask in interface SslTaskExecutor

Parameters:

task - Runnable SSL task to complete.