Package net.officefloor.web.build

Interface WebArchitect

All Known Implementing Classes:

WebArchitectEmployer

public interface WebArchitect

Web configuration extensions for the OfficeArchitect.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HANDLER_INPUT_NAME	Name of the OfficeSectionInput that handles the HttpRequest instances.
static final String	HANDLER_SECTION_NAME	Name of the OfficeSection that handles the HttpRequest instances.

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

Field Details

HANDLER_SECTION_NAME

static final String HANDLER_SECTION_NAME

Name of the OfficeSection that handles the HttpRequest instances.

See Also:

• Constant Field Values

HANDLER_INPUT_NAME

static final String HANDLER_INPUT_NAME

Name of the OfficeSectionInput that handles the HttpRequest instances.

See Also:

• Constant Field Values

Method Details

addHttpObjectParser

void addHttpObjectParser(HttpObjectParserFactory objectParserFactory)

Manually adds a HttpObjectParserFactory.

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

Parameters:

objectParserFactory - HttpObjectParserFactory.

setDefaultHttpObjectParser

void setDefaultHttpObjectParser(HttpObjectParserServiceFactory objectParserServiceFactory)

Specifies the default HttpObjectParserServiceFactory.

Parameters:

objectParserServiceFactory - Default HttpObjectParserServiceFactory.

addHttpObjectAnnotationAlias

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

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.

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.

addHttpObjectResponder

void addHttpObjectResponder(HttpObjectResponderFactory objectResponderFactory)

Adds a HttpObjectResponderFactory.

Parameters:

objectResponderFactory - HttpObjectResponderFactory.

setDefaultHttpObjectResponder

void setDefaultHttpObjectResponder(HttpObjectResponderServiceFactory objectResponderServiceFactory)

Specifies the default HttpObjectResponderServiceFactory.

Parameters:

objectResponderServiceFactory - Default HttpObjectResponderServiceFactory.

addHttpApplicationObject

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

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

Parameters:

objectClass - Class of the object.

bindName - Name to bind the object within the HttpApplicationState.

Returns:

OfficeManagedObject.

addHttpApplicationObject

OfficeManagedObject addHttpApplicationObject(Class<?> objectClass)

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.

Parameters:

objectClass - Class of the object.

Returns:

OfficeManagedObject.

addHttpSessionObject

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

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

Parameters:

objectClass - Class of the object.

bindName - Name to bind the object within the HttpSession.

Returns:

OfficeManagedObject.

addHttpSessionObject

OfficeManagedObject addHttpSessionObject(Class<?> objectClass)

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.

Parameters:

objectClass - Class of the object.

Returns:

OfficeManagedObject.

addHttpRequestObject

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

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

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

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

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.

Parameters:

objectClass - Class of the object.

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

Returns:

OfficeManagedObject.

addHttpArgument

OfficeManagedObject addHttpArgument(String parameterName,
 HttpValueLocation location)

Adds a HTTP argument.

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.

addHttpObject

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

Adds a HTTP Object to be parsed from the HttpRequest.

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.

isPathParameters

boolean isPathParameters(String path)

Indicates if the path contains path parameters.

Parameters:

path - Path.

Returns:

true if path contains parameters.

getHttpInput

HttpUrlContinuation getHttpInput(boolean isSecure,
 String applicationPath)

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

Parameters:

isSecure - Indicates if secure connection required.

applicationPath - Application path to be linked.

Returns:

HttpUrlContinuation.

getHttpInput

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

Creates a HttpInput into the application.

Parameters:

isSecure - Indicates if secure connection required.

httpMethodName - Name of the HttpMethod.

applicationPath - URL path of the application to be linked.

Returns:

HttpInput.

addHttpInputExplorer

void addHttpInputExplorer(HttpInputExplorer explorer)

Adds a HttpInputExplorer.

Parameters:

explorer - HttpInputExplorer.

reroute

void reroute(OfficeFlowSourceNode flowSourceNode)

Runs the ServerHttpConnection through routing again.

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

Parameters:

flowSourceNode - OfficeFlowSourceNode to trigger re-routing the ServerHttpConnection.

intercept

void intercept(OfficeFlowSinkNode flowSinkNode,
 OfficeFlowSourceNode flowSourceNode)

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.

Parameters:

flowSinkNode - OfficeFlowSinkNode to handle intercepting the HttpRequest.

flowSourceNode - OfficeFlowSourceNode to continue servicing the HttpRequest.

chainServicer

void chainServicer(OfficeFlowSinkNode flowSinkNode,
 OfficeFlowSourceNode notHandledOutput)

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.

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

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

Creates the AcceptNegotiatorBuilder to build an AcceptNegotiator.

Type Parameters:

H - Handler type.

Parameters:

handlerType - Handler type.

Returns:

AcceptNegotiatorBuilder to build an AcceptNegotiator.

enableHttpExternalResponse

void enableHttpExternalResponse()

Enable HttpExternalResponse being available.

informOfficeArchitect

void informOfficeArchitect()

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