Package net.officefloor.server.http

Class HttpServerSocketManagedObjectSource

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

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

net.officefloor.server.http.HttpServerSocketManagedObjectSource

All Implemented Interfaces:

ManagedFunction<Indexed,None>, ThreadCompletionListener, ManagedObjectSource<None,Indexed>

@PrivateSource
public class HttpServerSocketManagedObjectSource
extends AbstractManagedObjectSource<None,Indexed>
implements ManagedFunction<Indexed,None>, ThreadCompletionListener

ManagedObjectSource for a ServerHttpConnection.

Author:

Daniel Sagenschneider

Nested Class Summary

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

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HANDLE_REQUEST_FLOW_NAME	Name of the Flow to handle the request.
static final String	PROPERTY_MAX_ENTITY_LENGTH	Name of Property for the maximum entity length for HTTP parsing.
static final String	PROPERTY_MAX_HEADER_COUNT	Name of Property for the maximum HttpHeader per HttpRequest.
static final String	PROPERTY_MAX_TEXT_LENGTH	Name of Property for the maximum text length for HTTP parsing.
static final String	PROPERTY_SECURE	Name of Property indicating if secure.
static final String	SSL_TEAM_NAME	Name of the Team to execute the SSL tasks.
static final String	SYSTEM_PROPERTY_CORE_BUFFER_POOL_MAX_SIZE	Name of System property to obtain the maximum ThreadLocalStreamBufferPool core pool size.
static final String	SYSTEM_PROPERTY_MAX_ACTIVE_SOCKET_REQUESTS	Name of System property to obtain the maximum number of active requests on the socket.
static final String	SYSTEM_PROPERTY_MAX_READS_ON_SELECT	Name of System property to obtain the maximum number of reads for a SocketChannel per select.
static final String	SYSTEM_PROPERTY_MEMORY_THRESHOLD_PERCENTAGE	Name of System property to obtain the memory threshold percentage.
static final String	SYSTEM_PROPERTY_RECEIVE_BUFFER_SIZE	Name of System property to obtain the receive buffer size of the Socket.
static final String	SYSTEM_PROPERTY_SEND_BUFFER_SIZE	Name of System property to obtain the send buffer size of the Socket.
static final String	SYSTEM_PROPERTY_SOCKET_LISTENER_COUNT	Name of System property to specify the number of SocketServicer instances.
static final String	SYSTEM_PROPERTY_STREAM_BUFFER_SIZE	Name of System property to obtain the pooled StreamBuffer size.
static final String	SYSTEM_PROPERTY_THREADLOCAL_BUFFER_POOL_MAX_SIZE	Name of System property to obtain the maximum ThreadLocalStreamBufferPool ThreadLocal pool size.

Constructor Summary

Constructors

Constructor	Description
HttpServerSocketManagedObjectSource()	Default constructor to configure from PropertyList.
HttpServerSocketManagedObjectSource(HttpServerLocation serverLocation, HttpHeaderValue serverName, DateHttpHeaderClock dateHttpHeaderClock, boolean isIncludeEscalationStackTrace)	Instantiate for non-secure servicing.
HttpServerSocketManagedObjectSource(HttpServerLocation serverLocation, HttpHeaderValue serverName, DateHttpHeaderClock dateHttpHeaderClock, boolean isIncludeEscalationStackTrace, SSLContext sslContext)	Instantiate for secure servicing.

Method Summary

Modifier and Type	Method	Description
static SocketManager	createSocketManager(ThreadFactory[] executionStrategy, Consumer<ThreadCompletionListener> threadCompletionListenerCapture)	Creates the SocketManager configured from System properties.
void	execute(ManagedFunctionContext<Indexed,None> context)	Executes the function.
protected AcceptedSocketDecorator	getAcceptedSocketDecorator(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> context)	Enables overriding to configure the AcceptedSocketDecorator.
protected ManagedObject	getManagedObject()	Synchronously obtains the ManagedObject.
protected ServerSocketDecorator	getServerSocketDecorator(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> context)	Enables overriding to configure a ServerSocketDecorator.
static boolean	isSocketManagerActive()	Indicates if there is an active SocketManager for HttpServerSocketManagedObjectSource instances.
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	threadComplete()	Notifies that the Thread has completed.

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

sourceManagedObject

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

getSpecification, init, stop

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_PROPERTY_SOCKET_LISTENER_COUNT

public static final String SYSTEM_PROPERTY_SOCKET_LISTENER_COUNT

Name of System property to specify the number of SocketServicer instances. If not specified, will default to Runtime.availableProcessors().

See Also:

• Constant Field Values

SYSTEM_PROPERTY_STREAM_BUFFER_SIZE

public static final String SYSTEM_PROPERTY_STREAM_BUFFER_SIZE

Name of System property to obtain the pooled StreamBuffer size.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_RECEIVE_BUFFER_SIZE

public static final String SYSTEM_PROPERTY_RECEIVE_BUFFER_SIZE

Name of System property to obtain the receive buffer size of the Socket.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_MAX_READS_ON_SELECT

public static final String SYSTEM_PROPERTY_MAX_READS_ON_SELECT

Name of System property to obtain the maximum number of reads for a SocketChannel per select.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_MAX_ACTIVE_SOCKET_REQUESTS

public static final String SYSTEM_PROPERTY_MAX_ACTIVE_SOCKET_REQUESTS

Name of System property to obtain the maximum number of active requests on the socket.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_SEND_BUFFER_SIZE

public static final String SYSTEM_PROPERTY_SEND_BUFFER_SIZE

Name of System property to obtain the send buffer size of the Socket.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_THREADLOCAL_BUFFER_POOL_MAX_SIZE

public static final String SYSTEM_PROPERTY_THREADLOCAL_BUFFER_POOL_MAX_SIZE

Name of System property to obtain the maximum ThreadLocalStreamBufferPool ThreadLocal pool size.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_CORE_BUFFER_POOL_MAX_SIZE

public static final String SYSTEM_PROPERTY_CORE_BUFFER_POOL_MAX_SIZE

Name of System property to obtain the maximum ThreadLocalStreamBufferPool core pool size.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_MEMORY_THRESHOLD_PERCENTAGE

public static final String SYSTEM_PROPERTY_MEMORY_THRESHOLD_PERCENTAGE

Name of System property to obtain the memory threshold percentage.

See Also:

• Constant Field Values

PROPERTY_SECURE

public static final String PROPERTY_SECURE

Name of Property indicating if secure.

See Also:

• Constant Field Values

PROPERTY_MAX_HEADER_COUNT

public static final String PROPERTY_MAX_HEADER_COUNT

Name of Property for the maximum HttpHeader per HttpRequest.

See Also:

• Constant Field Values

PROPERTY_MAX_TEXT_LENGTH

public static final String PROPERTY_MAX_TEXT_LENGTH

Name of Property for the maximum text length for HTTP parsing.

See Also:

• Constant Field Values

PROPERTY_MAX_ENTITY_LENGTH

public static final String PROPERTY_MAX_ENTITY_LENGTH

Name of Property for the maximum entity length for HTTP parsing.

See Also:

• Constant Field Values

HANDLE_REQUEST_FLOW_NAME

public static final String HANDLE_REQUEST_FLOW_NAME

Name of the Flow to handle the request.

See Also:

• Constant Field Values

SSL_TEAM_NAME

public static final String SSL_TEAM_NAME

Name of the Team to execute the SSL tasks.

See Also:

• Constant Field Values

Constructor Details

HttpServerSocketManagedObjectSource

public HttpServerSocketManagedObjectSource()

Default constructor to configure from PropertyList.

HttpServerSocketManagedObjectSource

public HttpServerSocketManagedObjectSource(HttpServerLocation serverLocation,
 HttpHeaderValue serverName,
 DateHttpHeaderClock dateHttpHeaderClock,
 boolean isIncludeEscalationStackTrace)

Instantiate for non-secure servicing.

Parameters:

serverLocation - HttpServerLocation.

serverName - Server HttpHeaderValue.

dateHttpHeaderClock - DateHttpHeaderClock.

isIncludeEscalationStackTrace - Indicates if include the Escalation stack trace on the HttpResponse.

HttpServerSocketManagedObjectSource

public HttpServerSocketManagedObjectSource(HttpServerLocation serverLocation,
 HttpHeaderValue serverName,
 DateHttpHeaderClock dateHttpHeaderClock,
 boolean isIncludeEscalationStackTrace,
 SSLContext sslContext)

Instantiate for secure servicing.

Parameters:

serverLocation - HttpServerLocation.

serverName - Server HttpHeaderValue.

dateHttpHeaderClock - DateHttpHeaderClock.

isIncludeEscalationStackTrace - Indicates if include the Escalation stack trace on the HttpResponse.

sslContext - SSLContext. May be null if behind reverse proxy handling secure communication.

Method Details

createSocketManager

public static SocketManager createSocketManager(ThreadFactory[] executionStrategy,
 Consumer<ThreadCompletionListener> threadCompletionListenerCapture)
                                         throws IOException

Creates the SocketManager configured from System properties.

Parameters:

executionStrategy - ThreadFactory instances for the ExecutionStrategy for the SocketManager.

threadCompletionListenerCapture - Captures the ThreadCompletionListener for the SocketManager. May be null.

Returns:

SocketManager configured from System properties.

Throws:

IOException - If fails to create the SocketManager.

isSocketManagerActive

public static boolean isSocketManagerActive()

Indicates if there is an active SocketManager for HttpServerSocketManagedObjectSource instances.

Returns:

true if active SocketManager.

getServerSocketDecorator

protected ServerSocketDecorator getServerSocketDecorator(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> context)

Enables overriding to configure a ServerSocketDecorator.

Parameters:

context - AbstractAsyncManagedObjectSource.MetaDataContext.

Returns:

ServerSocketDecorator.

getAcceptedSocketDecorator

protected AcceptedSocketDecorator getAcceptedSocketDecorator(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> context)

Enables overriding to configure the AcceptedSocketDecorator.

Parameters:

context - AbstractAsyncManagedObjectSource.MetaDataContext.

Returns:

AcceptedSocketDecorator.

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.

execute

public void execute(ManagedFunctionContext<Indexed,None> context)
             throws Throwable

Description copied from interface: ManagedFunction

Executes the function.

Specified by:

execute in interface ManagedFunction<Indexed,None>

Parameters:

context - ManagedFunctionContext for the ManagedFunction.

Throws:

Throwable - Indicating failure of the ManagedFunction.

threadComplete

public void threadComplete()

Description copied from interface: ThreadCompletionListener

Notifies that the Thread has completed.

Specified by:

threadComplete in interface ThreadCompletionListener