net.officefloor.plugin.socket.server.http.protocol

Class HttpCommunicationProtocol

java.lang.Object

net.officefloor.plugin.socket.server.http.protocol.HttpCommunicationProtocol

All Implemented Interfaces:

CommunicationProtocol, CommunicationProtocolSource

public class HttpCommunicationProtocol
extends Object
implements CommunicationProtocolSource, CommunicationProtocol

HTTP CommunicationProtocolSource.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_VALUE_CONNECTION_TIMEOUT Default value for property PROPERTY_CONNECTION_TIMEOUT.
static boolean	DEFAULT_VALUE_IS_SEND_STACK_TRACE_ON_FAILURE Default value for property PROPERTY_IS_SEND_STACK_TRACE_ON_FAILURE.
static int	DEFAULT_VALUE_MAXIMUM_HTTP_REQUEST_HEADERS Default value for the property PROPERTY_MAXIMUM_HTTP_REQUEST_HEADERS.
static long	DEFAULT_VALUE_MAXIMUM_REQUEST_BODY_LENGTH Default value for property PROPERTY_MAXIMUM_REQUEST_BODY_LENGTH.
static int	DEFAULT_VALUE_MAXIMUM_TEXT_PART_LENGTH Default value for property PROPERTY_MAXIMUM_TEXT_PART_LENGTH.
static String	PROPERTY_CONNECTION_TIMEOUT Property name for the connection timeout.
static String	PROPERTY_HTTP_SERVER_CLOCK_SOURCE Property name for the HttpServerClockSource class.
static String	PROPERTY_IS_SEND_STACK_TRACE_ON_FAILURE Name of property to determine if send stack trace on failure.
static String	PROPERTY_MAXIMUM_HTTP_REQUEST_HEADERS Name of property to indicate the maximum number of HttpHeader instances per HttpRequest.
static String	PROPERTY_MAXIMUM_REQUEST_BODY_LENGTH Property name for the maximum length in bytes of the HttpRequest body.
static String	PROPERTY_MAXIMUM_TEXT_PART_LENGTH Property name for the maximum length of a text part for the HttpRequest.

Constructor Summary

Constructors

Constructor and Description
HttpCommunicationProtocol()

Method Summary

Modifier and Type	Method and Description
CommunicationProtocol	createCommunicationProtocol(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> configurationContext, CommunicationProtocolContext protocolContext) Creates the CommunicationProtocol.
HttpConnectionHandler	createConnectionHandler(Connection connection) Creates a ConnectionHandler for a new Connection.
void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Loads any specifications for this communication protocol.
void	serviceHttpRequest(HttpConnectionHandler handler, HttpManagedObject httpManagedObject) Services the HttpRequest.
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_IS_SEND_STACK_TRACE_ON_FAILURE

public static final String PROPERTY_IS_SEND_STACK_TRACE_ON_FAILURE

Name of property to determine if send stack trace on failure.

See Also:

Constant Field Values

DEFAULT_VALUE_IS_SEND_STACK_TRACE_ON_FAILURE

public static final boolean DEFAULT_VALUE_IS_SEND_STACK_TRACE_ON_FAILURE

Default value for property PROPERTY_IS_SEND_STACK_TRACE_ON_FAILURE.

See Also:

Constant Field Values

PROPERTY_MAXIMUM_HTTP_REQUEST_HEADERS

public static final String PROPERTY_MAXIMUM_HTTP_REQUEST_HEADERS

Name of property to indicate the maximum number of HttpHeader instances per HttpRequest.

See Also:

Constant Field Values

DEFAULT_VALUE_MAXIMUM_HTTP_REQUEST_HEADERS

public static final int DEFAULT_VALUE_MAXIMUM_HTTP_REQUEST_HEADERS

Default value for the property PROPERTY_MAXIMUM_HTTP_REQUEST_HEADERS.

See Also:

Constant Field Values

PROPERTY_MAXIMUM_REQUEST_BODY_LENGTH

public static final String PROPERTY_MAXIMUM_REQUEST_BODY_LENGTH

Property name for the maximum length in bytes of the HttpRequest body.

See Also:

Constant Field Values

DEFAULT_VALUE_MAXIMUM_REQUEST_BODY_LENGTH

public static final long DEFAULT_VALUE_MAXIMUM_REQUEST_BODY_LENGTH

Default value for property PROPERTY_MAXIMUM_REQUEST_BODY_LENGTH.

See Also:

Constant Field Values

PROPERTY_CONNECTION_TIMEOUT

public static final String PROPERTY_CONNECTION_TIMEOUT

Property name for the connection timeout.

See Also:

Constant Field Values

DEFAULT_VALUE_CONNECTION_TIMEOUT

public static final long DEFAULT_VALUE_CONNECTION_TIMEOUT

Default value for property PROPERTY_CONNECTION_TIMEOUT.

See Also:

Constant Field Values

PROPERTY_MAXIMUM_TEXT_PART_LENGTH

public static final String PROPERTY_MAXIMUM_TEXT_PART_LENGTH

Property name for the maximum length of a text part for the HttpRequest.

See Also:

Constant Field Values

DEFAULT_VALUE_MAXIMUM_TEXT_PART_LENGTH

public static final int DEFAULT_VALUE_MAXIMUM_TEXT_PART_LENGTH

Default value for property PROPERTY_MAXIMUM_TEXT_PART_LENGTH.

See Also:

Constant Field Values

PROPERTY_HTTP_SERVER_CLOCK_SOURCE

public static String PROPERTY_HTTP_SERVER_CLOCK_SOURCE

Property name for the HttpServerClockSource class.

Constructor Detail

HttpCommunicationProtocol

public HttpCommunicationProtocol()

Method Detail

serviceHttpRequest

public void serviceHttpRequest(HttpConnectionHandler handler,
                               HttpManagedObject httpManagedObject)

Services the HttpRequest.

Parameters:

handler - HttpConnectionHandler.

httpManagedObject - HttpManagedObject for the HttpRequest.

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 HttpConnectionHandler 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.