Package net.officefloor.web

Class WebArchitectEmployer

java.lang.Object

net.officefloor.web.WebArchitectEmployer

All Implemented Interfaces:

WebArchitect

public class WebArchitectEmployer
extends Object
implements WebArchitect

WebArchitect implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_CONTEXT_PATH	Name of Property specifying the context path.

Fields inherited from interface net.officefloor.web.build.WebArchitect

HANDLER_INPUT_NAME, HANDLER_SECTION_NAME

Method Summary

Modifier and Type	Method	Description
OfficeManagedObject	addHttpApplicationObject(Class<?> objectClass)	Adds an object to be lazily created and stored within the HttpApplicationState.
OfficeManagedObject	addHttpApplicationObject(Class<?> objectClass, String bindName)	Adds an object to be lazily created and stored within the HttpApplicationState.
OfficeManagedObject	addHttpArgument(String parameterName, HttpValueLocation location)	Adds a HTTP argument.
void	addHttpInputExplorer(HttpInputExplorer explorer)	Adds a HttpInputExplorer.
OfficeManagedObject	addHttpObject(Class<?> objectClass, String... acceptedContentTypes)	Adds a HTTP Object to be parsed from the HttpRequest.
void	addHttpObjectAnnotationAlias(Class<?> httpObjectAnnotationAliasClass, String... acceptedContentTypes)	Adds another Class as an alias for the HttpObject annotation.
void	addHttpObjectParser(HttpObjectParserFactory objectParserFactory)	Manually adds a HttpObjectParserFactory.
void	addHttpObjectResponder(HttpObjectResponderFactory objectResponderFactory)	Adds a HttpObjectResponderFactory.
OfficeManagedObject	addHttpRequestObject(Class<?> objectClass, boolean isLoadParameters)	Adds an object to be lazily created and stored within the HttpRequestState.
OfficeManagedObject	addHttpRequestObject(Class<?> objectClass, boolean isLoadParameters, String bindName)	Adds an object to be lazily created and stored within the HttpRequestState.
OfficeManagedObject	addHttpSessionObject(Class<?> objectClass)	Adds an object to be lazily created and stored within the HttpSession.
OfficeManagedObject	addHttpSessionObject(Class<?> objectClass, String bindName)	Adds an object to be lazily created and stored within the HttpSession.
void	chainServicer(OfficeFlowSinkNode flowSinkNode, OfficeFlowSourceNode notHandledOutput)	Chains a OfficeSectionInput to the end of the servicing chain to handle a HttpRequest.
<H> AcceptNegotiatorBuilder<H>	createAcceptNegotiator(Class<H> handlerType)	Creates the AcceptNegotiatorBuilder to build an AcceptNegotiator.
static WebArchitect	employWebArchitect(String contextPath, OfficeArchitect officeArchitect, OfficeSourceContext officeSourceContext)	Employs a WebArchitect.
static WebArchitect	employWebArchitect(OfficeArchitect officeArchitect, OfficeSourceContext officeSourceContext)	Employs a WebArchitect.
void	enableHttpExternalResponse()	Enable HttpExternalResponse being available.
HttpUrlContinuation	getHttpInput(boolean isSecure, String applicationPath)	Creates a HttpUrlContinuation into the web application.
HttpInput	getHttpInput(boolean isSecure, String httpMethodName, String applicationPath)	Creates a HttpInput into the application.
void	informOfficeArchitect()	Informs the OfficeArchitect of the web architect.
void	intercept(OfficeFlowSinkNode flowSinkNode, OfficeFlowSourceNode flowSourceNode)	Intercepts all HttpRequest instances before servicing.
boolean	isPathParameters(String path)	Indicates if the path contains path parameters.
void	reroute(OfficeFlowSourceNode flowSourceNode)	Runs the ServerHttpConnection through routing again.
void	setDefaultHttpObjectParser(HttpObjectParserServiceFactory objectParserServiceFactory)	Specifies the default HttpObjectParserServiceFactory.
void	setDefaultHttpObjectResponder(HttpObjectResponderServiceFactory objectResponderServiceFactory)	Specifies the default HttpObjectResponderServiceFactory.

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_CONTEXT_PATH

public static final String PROPERTY_CONTEXT_PATH

Name of Property specifying the context path.

See Also:

• Constant Field Values

Method Details

employWebArchitect

public static WebArchitect employWebArchitect(OfficeArchitect officeArchitect,
 OfficeSourceContext officeSourceContext)

Employs a WebArchitect.

Parameters:

officeArchitect - OfficeArchitect.

officeSourceContext - OfficeSourceContext used to source Property values to configure the WebArchitect.

Returns:

WebArchitect.

employWebArchitect

public static WebArchitect employWebArchitect(String contextPath,
 OfficeArchitect officeArchitect,
 OfficeSourceContext officeSourceContext)

Employs a WebArchitect.

Parameters:

contextPath - Context path for the web application. May be null for no context path.

officeArchitect - OfficeArchitect.

officeSourceContext - OfficeSourceContext used to source Property values to configure the WebArchitect.

Returns:

WebArchitect.

addHttpArgument

public OfficeManagedObject addHttpArgument(String parameterName,
 HttpValueLocation location)

Description copied from interface: WebArchitect

Adds a HTTP argument.

Specified by:

addHttpArgument in interface WebArchitect

Parameters:

parameterName - Name of the parameter.

location - HttpValueLocation to obtain the argument value. May be null to obtain from anywhere on the HttpRequest.

Returns:

OfficeManagedObject.

addHttpApplicationObject

public OfficeManagedObject addHttpApplicationObject(Class<?> objectClass,
 String bindName)

Description copied from interface: WebArchitect

Adds an object to be lazily created and stored within the HttpApplicationState.

Specified by:

addHttpApplicationObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

bindName - Name to bind the object within the HttpApplicationState.

Returns:

OfficeManagedObject.

addHttpApplicationObject

public OfficeManagedObject addHttpApplicationObject(Class<?> objectClass)

Description copied from interface: WebArchitect

Adds an object to be lazily created and stored within the HttpApplicationState.

The bound name is arbitrarily chosen but will be unique for the object.

Specified by:

addHttpApplicationObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

Returns:

OfficeManagedObject.

addHttpSessionObject

public OfficeManagedObject addHttpSessionObject(Class<?> objectClass,
 String bindName)

Description copied from interface: WebArchitect

Adds an object to be lazily created and stored within the HttpSession.

Specified by:

addHttpSessionObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

bindName - Name to bind the object within the HttpSession.

Returns:

OfficeManagedObject.

addHttpSessionObject

public OfficeManagedObject addHttpSessionObject(Class<?> objectClass)

Description copied from interface: WebArchitect

Adds an object to be lazily created and stored within the HttpSession.

The bound name is arbitrarily chosen but will be unique for the object.

Specified by:

addHttpSessionObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

Returns:

OfficeManagedObject.

addHttpRequestObject

public OfficeManagedObject addHttpRequestObject(Class<?> objectClass,
 boolean isLoadParameters,
 String bindName)

Description copied from interface: WebArchitect

Adds an object to be lazily created and stored within the HttpRequestState.

Specified by:

addHttpRequestObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

isLoadParameters - Indicates whether to load the HTTP parameters to instantiated objects.

bindName - Name to bind the object within the HttpRequestState.

Returns:

OfficeManagedObject.

addHttpRequestObject

public OfficeManagedObject addHttpRequestObject(Class<?> objectClass,
 boolean isLoadParameters)

Description copied from interface: WebArchitect

Adds an object to be lazily created and stored within the HttpRequestState.

The bound name is arbitrarily chosen but will be unique for the object.

Specified by:

addHttpRequestObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

isLoadParameters - Indicates whether to load the HTTP parameters to instantiated objects.

Returns:

OfficeManagedObject.

addHttpObjectParser

public void addHttpObjectParser(HttpObjectParserFactory objectParserFactory)

Description copied from interface: WebArchitect

Manually adds a HttpObjectParserFactory.

Typically these should be configured via HttpObjectParserServiceFactory, so can be plugged in as required.

Specified by:

addHttpObjectParser in interface WebArchitect

Parameters:

objectParserFactory - HttpObjectParserFactory.

setDefaultHttpObjectParser

public void setDefaultHttpObjectParser(HttpObjectParserServiceFactory objectParserServiceFactory)

Description copied from interface: WebArchitect

Specifies the default HttpObjectParserServiceFactory.

Specified by:

setDefaultHttpObjectParser in interface WebArchitect

Parameters:

objectParserServiceFactory - Default HttpObjectParserServiceFactory.

addHttpObjectAnnotationAlias

public void addHttpObjectAnnotationAlias(Class<?> httpObjectAnnotationAliasClass,
 String... acceptedContentTypes)

Description copied from interface: WebArchitect

Adds another Class as an alias for the HttpObject annotation.

As code generators are likely to be used for the HTTP objects, it is not always possible to generate the Class annotated with HttpObject. This allows another Annotation to indicate the parameter object is a HTTP object.

Specified by:

addHttpObjectAnnotationAlias in interface WebArchitect

Parameters:

httpObjectAnnotationAliasClass - Alias Annotation Class for HttpObject.

acceptedContentTypes - Listing of the content-type values accepted. May be empty array to allow supporting all available content-type HttpObjectParser instances available.

addHttpObject

public OfficeManagedObject addHttpObject(Class<?> objectClass,
 String... acceptedContentTypes)

Description copied from interface: WebArchitect

Adds a HTTP Object to be parsed from the HttpRequest.

Specified by:

addHttpObject in interface WebArchitect

Parameters:

objectClass - Class of the object.

acceptedContentTypes - Listing of the content-type values accepted. May be empty array to allow supporting all available content-type HttpObjectParser instances available.

Returns:

OfficeManagedObject.

addHttpObjectResponder

public void addHttpObjectResponder(HttpObjectResponderFactory objectResponderFactory)

Description copied from interface: WebArchitect

Adds a HttpObjectResponderFactory.

Specified by:

addHttpObjectResponder in interface WebArchitect

Parameters:

objectResponderFactory - HttpObjectResponderFactory.

setDefaultHttpObjectResponder

public void setDefaultHttpObjectResponder(HttpObjectResponderServiceFactory objectResponderServiceFactory)

Description copied from interface: WebArchitect

Specifies the default HttpObjectResponderServiceFactory.

Specified by:

setDefaultHttpObjectResponder in interface WebArchitect

Parameters:

objectResponderServiceFactory - Default HttpObjectResponderServiceFactory.

isPathParameters

public boolean isPathParameters(String path)

Description copied from interface: WebArchitect

Indicates if the path contains path parameters.

Specified by:

isPathParameters in interface WebArchitect

Parameters:

path - Path.

Returns:

true if path contains parameters.

getHttpInput

public HttpUrlContinuation getHttpInput(boolean isSecure,
 String applicationPath)

Description copied from interface: WebArchitect

Creates a HttpUrlContinuation into the web application. This will always be a HttpMethod.GET due to redirection required for the HttpUrlContinuation.

Specified by:

getHttpInput in interface WebArchitect

Parameters:

isSecure - Indicates if secure connection required.

applicationPath - Application path to be linked.

Returns:

HttpUrlContinuation.

getHttpInput

public HttpInput getHttpInput(boolean isSecure,
 String httpMethodName,
 String applicationPath)

Description copied from interface: WebArchitect

Creates a HttpInput into the application.

Specified by:

getHttpInput in interface WebArchitect

Parameters:

isSecure - Indicates if secure connection required.

httpMethodName - Name of the HttpMethod.

applicationPath - URL path of the application to be linked.

Returns:

HttpInput.

addHttpInputExplorer

public void addHttpInputExplorer(HttpInputExplorer explorer)

Description copied from interface: WebArchitect

Adds a HttpInputExplorer.

Specified by:

addHttpInputExplorer in interface WebArchitect

Parameters:

explorer - HttpInputExplorer.

reroute

public void reroute(OfficeFlowSourceNode flowSourceNode)

Description copied from interface: WebArchitect

Runs the ServerHttpConnection through routing again.

Typically, this is used on importing previous state into the ServerHttpConnection and then have it serviced.

Specified by:

reroute in interface WebArchitect

Parameters:

flowSourceNode - OfficeFlowSourceNode to trigger re-routing the ServerHttpConnection.

intercept

public void intercept(OfficeFlowSinkNode flowSinkNode,
 OfficeFlowSourceNode flowSourceNode)

Description copied from interface: WebArchitect

Intercepts all HttpRequest instances before servicing. Multiple intercepts may be configured, with them executed in the order they are added.

This allows, for example, logging all requests to the web application.

Specified by:

intercept in interface WebArchitect

Parameters:

flowSinkNode - OfficeFlowSinkNode to handle intercepting the HttpRequest.

flowSourceNode - OfficeFlowSourceNode to continue servicing the HttpRequest.

chainServicer

public void chainServicer(OfficeFlowSinkNode flowSinkNode,
 OfficeFlowSourceNode notHandledOutput)

Description copied from interface: WebArchitect

Chains a OfficeSectionInput to the end of the servicing chain to handle a HttpRequest. Multiple chained services may be added, with them executed in the order they are added.

The WebArchitect functionality is always the first in the chain to attempt to service the HttpRequest. This allows, for example, adding a chained servicer for serving resources from a file system.

Specified by:

chainServicer in interface WebArchitect

Parameters:

flowSinkNode - OfficeFlowSinkNode to handle the HttpRequest.

notHandledOutput - OfficeFlowSourceNode should this servicer not handle the HttpRequest. May be null if handles all HttpRequest instances (any services chained after this will therefore not be used).

createAcceptNegotiator

public <H> AcceptNegotiatorBuilder<H> createAcceptNegotiator(Class<H> handlerType)

Description copied from interface: WebArchitect

Creates the AcceptNegotiatorBuilder to build an AcceptNegotiator.

Specified by:

createAcceptNegotiator in interface WebArchitect

Type Parameters:

H - Handler type.

Parameters:

handlerType - Handler type.

Returns:

AcceptNegotiatorBuilder to build an AcceptNegotiator.

enableHttpExternalResponse

public void enableHttpExternalResponse()

Description copied from interface: WebArchitect

Enable HttpExternalResponse being available.

Specified by:

enableHttpExternalResponse in interface WebArchitect

informOfficeArchitect

public void informOfficeArchitect()

Description copied from interface: WebArchitect

Informs the OfficeArchitect of the web architect. This is to be invoked once all web architecture is configured.

Specified by:

informOfficeArchitect in interface WebArchitect