net.officefloor.plugin.socket.server.impl

Class AbstractServerSocketManagedObjectSource

java.lang.Object

net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource<D,F>

net.officefloor.frame.spi.managedobject.source.impl.AbstractManagedObjectSource<None,Indexed>

net.officefloor.plugin.socket.server.impl.AbstractServerSocketManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<None,Indexed>, CommunicationProtocolContext

Direct Known Subclasses:

HttpServerSocketManagedObjectSource, HttpsServerSocketManagedObjectSource, SecureTcpServerSocketManagedObjectSource, TcpServerSocketManagedObjectSource

public abstract class AbstractServerSocketManagedObjectSource
extends AbstractManagedObjectSource<None,Indexed>
implements CommunicationProtocolContext

Abstract ManagedObjectSource for a ServerSocketChannel.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller, AbstractAsyncManagedObjectSource.Labeller, AbstractAsyncManagedObjectSource.MetaDataContext<D extends Enum<D>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET Default Charset to use if one is not configured.
static String	PROPERTY_DEFAULT_CHARSET Name of property to obtain the default Charset.
static String	PROPERTY_PORT Port property name.
static String	PROPERTY_RECEIVE_BUFFER_SIZE Name of property to obtain the receive buffer size.
static String	PROPERTY_SEND_BUFFER_SIZE Name of property to obtain the send buffer size.

Constructor Summary

Constructors

Constructor and Description
AbstractServerSocketManagedObjectSource() Initiate.

Method Summary

Modifier and Type	Method and Description
static void	closeConnectionManager() Closes the possible open ConnectionManager and releases all Selector instances for the SocketListener instances.
protected abstract CommunicationProtocolSource	createCommunicationProtocolSource() Creates the CommunicationProtocolSource.
static Charset	getCharset(SourceProperties properties) Obtains the Charset.
Charset	getDefaultCharset() Obtains the default Charset for the server.
protected ManagedObject	getManagedObject() Synchronously obtains the ManagedObject.
int	getSendBufferSize() Obtains the size of the ByteBuffer instances for writing.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> context) Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Overridden to load specifications.
void	start(ManagedObjectExecuteContext<Indexed> context) Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.
void	stop() Called to notify that the OfficeFloor is being closed.

Methods inherited from class net.officefloor.frame.spi.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.spi.managedobject.source.impl.AbstractAsyncManagedObjectSource

getMetaData, getSpecification, init

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PORT

public static final String PROPERTY_PORT

Port property name.

See Also:

Constant Field Values

PROPERTY_SEND_BUFFER_SIZE

public static final String PROPERTY_SEND_BUFFER_SIZE

Name of property to obtain the send buffer size.

See Also:

Constant Field Values

PROPERTY_RECEIVE_BUFFER_SIZE

public static final String PROPERTY_RECEIVE_BUFFER_SIZE

Name of property to obtain the receive buffer size.

See Also:

Constant Field Values

PROPERTY_DEFAULT_CHARSET

public static final String PROPERTY_DEFAULT_CHARSET

Name of property to obtain the default Charset.

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

Default Charset to use if one is not configured.

See Also:

Constant Field Values

Constructor Detail

AbstractServerSocketManagedObjectSource

public AbstractServerSocketManagedObjectSource()

Initiate.

Method Detail

getCharset

public static Charset getCharset(SourceProperties properties)

Obtains the Charset.

Parameters:

properties - SourceProperties. May be null if no SourceProperties are available.

Returns:

Charset.

closeConnectionManager

public static void closeConnectionManager()
                                   throws IOException

Closes the possible open ConnectionManager and releases all Selector instances for the SocketListener instances.

Made public so that tests may use to close.

Throws:

IOException - If fails to close the ConnectionManager.

createCommunicationProtocolSource

protected abstract CommunicationProtocolSource createCommunicationProtocolSource()

Creates the CommunicationProtocolSource.

Returns:

CommunicationProtocolSource.

getSendBufferSize

public int getSendBufferSize()

Description copied from interface: CommunicationProtocolContext

Obtains the size of the ByteBuffer instances for writing. The WriteBuffer sizes for data should not exceed this value.

This allows the CommunicationProtocolSource to create buffers that match size to reduce the amount of copy routines required.

Specified by:

getSendBufferSize in interface CommunicationProtocolContext

Returns:

Size of the write buffers for sending data.

getDefaultCharset

public Charset getDefaultCharset()

Description copied from interface: CommunicationProtocolContext

Obtains the default Charset for the server.

Specified by:

getDefaultCharset in interface CommunicationProtocolContext

Returns:

Default Charset for the server.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,Indexed>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,Indexed>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

start

public void start(ManagedObjectExecuteContext<Indexed> context)
           throws Exception

Description copied from interface: ManagedObjectSource

Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

On invocation of this method, ProcessState instances may be invoked via the ManagedObjectExecuteContext.

Specified by:

start in interface ManagedObjectSource<None,Indexed>

Overrides:

start in class AbstractAsyncManagedObjectSource<None,Indexed>

Parameters:

context - ManagedObjectExecuteContext to use in starting this ManagedObjectSource.

Throws:

Exception - Should the ManagedObjectSource fail to start execution.

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<None,Indexed>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.

stop

public void stop()

Description copied from interface: ManagedObjectSource

Called to notify that the OfficeFloor is being closed.

On return from this method, no further ProcessState instances may be invoked.

Specified by:

stop in interface ManagedObjectSource<None,Indexed>

Overrides:

stop in class AbstractAsyncManagedObjectSource<None,Indexed>