net.officefloor.plugin.web.http.application

Class WebApplicationAutoWireOfficeFloorSource

java.lang.Object

net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

net.officefloor.autowire.impl.AutoWireOfficeFloorSource

net.officefloor.plugin.web.http.application.WebApplicationAutoWireOfficeFloorSource

All Implemented Interfaces:

AutoWireApplication, OfficeFloorSource, WebAutoWireApplication

Direct Known Subclasses:

HttpServerAutoWireOfficeFloorSource, ServletWebAutoWireApplication

public class WebApplicationAutoWireOfficeFloorSource
extends AutoWireOfficeFloorSource
implements WebAutoWireApplication

AutoWireOfficeFloorSource providing web application functionality.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

AbstractOfficeFloorSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static ManagedObjectSourceWirer	processScopeWirer ManagedObjectSourceWirer to bind the ManagedObject to the ProcessState.

Fields inherited from interface net.officefloor.plugin.web.http.application.WebAutoWireApplication

HANDLER_INPUT_NAME, HANDLER_SECTION_NAME, WEB_PUBLIC_RESOURCES_CLASS_PATH_PREFIX

Constructor Summary

Constructors

Constructor and Description
WebApplicationAutoWireOfficeFloorSource() Initiate.

Method Summary

Modifier and Type	Method and Description
AutoWireObject	addHttpApplicationObject(Class<?> objectClass) Adds an object to be lazily created and stored within the HttpApplicationState.
AutoWireObject	addHttpApplicationObject(Class<?> objectClass, String bindName) Adds an object to be lazily created and stored within the HttpApplicationState.
AutoWireObject	addHttpRequestObject(Class<?> objectClass, boolean isLoadParameters) Adds an object to be lazily created and stored within the HttpRequestState.
AutoWireObject	addHttpRequestObject(Class<?> objectClass, boolean isLoadParameters, String bindName) Adds an object to be lazily created and stored within the HttpRequestState.
AutoWireObject	addHttpSessionObject(Class<?> objectClass) Adds an object to be lazily created and stored within the HttpSession.
AutoWireObject	addHttpSessionObject(Class<?> objectClass, String bindName) Adds an object to be lazily created and stored within the HttpSession.
HttpTemplateAutoWireSection	addHttpTemplate(String templateUri, String templateFilePath, Class<?> templateLogicClass) Adds a HttpTemplate available at the specified URI path.
void	chainServicer(AutoWireSection section, String inputName, String notHandledOutputName) Chains a OfficeSectionInput to the end of the servicing chain to handle a HttpRequest.
HttpSecurityAutoWireSection	getHttpSecurity() Obtains the configured HttpSecurityAutoWireSection.
static String	getTemplateSectionName(String templateUri) Obtains the HttpTemplate section name from the HttpTemplate URI.
String[]	getURIs() Obtains the linked URIs.
protected void	initOfficeFloor(OfficeFloorDeployer deployer, OfficeFloorSourceContext context) Allows overriding for initialising the OfficeFloor before auto-wiring.
void	linkEscalation(Class<? extends Throwable> escalation, HttpTemplateAutoWireSection template) Links the Escalation to be handled by the HttpTemplateAutoWireSection.
void	linkEscalation(Class<? extends Throwable> escalation, String resourcePath) Links the Escalation to be handled by the resource.
void	linkToHttpTemplate(AutoWireSection section, String outputName, HttpTemplateAutoWireSection template) Links the OfficeSectionOutput to render the HttpTemplate.
void	linkToResource(AutoWireSection section, String outputName, String resourcePath) Links to a resource.
void	linkToSendResponse(AutoWireSection section, String outputName) Links OfficeSectionOutput to sending the HttpResponse.
HttpUriLink	linkUri(String uri, AutoWireSection section, String inputName) Links a URI to an OfficeSectionInput.
void	setDefaultHttpTemplateUriSuffix(String uriSuffix) Specifies the default URI suffix for the HttpTemplate URI path and link URI paths.
HttpSecurityAutoWireSection	setHttpSecurity(Class<? extends HttpSecuritySource<?,?,?,?>> httpSecuritySourceClass) Specifies the HttpSecuritySource for this WebAutoWireApplication.

Methods inherited from class net.officefloor.autowire.impl.AutoWireOfficeFloorSource

addGovernance, addManagedObject, addObject, addSection, addSection, addSectionTransformer, addStartupFlow, addSupplier, assignDefaultTeam, assignTeam, getAppropriateAutoWire, getOfficeFloorCompiler, getSection, isLinked, isObjectAvailable, link, linkEscalation, loadSpecification, openOfficeFloor, setProfiler, sourceOfficeFloor, specifyConfigurationProperties

Methods inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

getSpecification

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.autowire.AutoWireApplication

addGovernance, addManagedObject, addObject, addSection, addSection, addSectionTransformer, addStartupFlow, addSupplier, assignDefaultTeam, assignTeam, getOfficeFloorCompiler, getSection, isLinked, isObjectAvailable, link, linkEscalation, openOfficeFloor, setProfiler

Field Detail

processScopeWirer

protected static final ManagedObjectSourceWirer processScopeWirer

ManagedObjectSourceWirer to bind the ManagedObject to the ProcessState.

Constructor Detail

WebApplicationAutoWireOfficeFloorSource

public WebApplicationAutoWireOfficeFloorSource()

Initiate.

Method Detail

getTemplateSectionName

public static String getTemplateSectionName(String templateUri)

Obtains the HttpTemplate section name from the HttpTemplate URI.

Parameters:

templateUri - HttpTemplate URI.

Returns:

HttpTemplate section name.

addHttpTemplate

public HttpTemplateAutoWireSection addHttpTemplate(String templateUri,
                                                   String templateFilePath,
                                                   Class<?> templateLogicClass)

Description copied from interface: WebAutoWireApplication

Adds a HttpTemplate available at the specified URI path.

Specified by:

addHttpTemplate in interface WebAutoWireApplication

Parameters:

templateUri - URI path for the template.

templateFilePath - Path to the template file.

templateLogicClass - Class providing the logic for the template. May be null if template does not require logic (e.g. static page with links).

Returns:

HttpTemplateAutoWireSection to allow linking flows.

setDefaultHttpTemplateUriSuffix

public void setDefaultHttpTemplateUriSuffix(String uriSuffix)

Description copied from interface: WebAutoWireApplication

Specifies the default URI suffix for the HttpTemplate URI path and link URI paths.

Specified by:

setDefaultHttpTemplateUriSuffix in interface WebAutoWireApplication

Parameters:

uriSuffix - Default HttpTemplate URI suffix.

setHttpSecurity

public HttpSecurityAutoWireSection setHttpSecurity(Class<? extends HttpSecuritySource<?,?,?,?>> httpSecuritySourceClass)

Description copied from interface: WebAutoWireApplication

Specifies the HttpSecuritySource for this WebAutoWireApplication.

Specified by:

setHttpSecurity in interface WebAutoWireApplication

Parameters:

httpSecuritySourceClass - HttpSecuritySource Class.

Returns:

HttpSecurityAutoWireSection.

getHttpSecurity

public HttpSecurityAutoWireSection getHttpSecurity()

Description copied from interface: WebAutoWireApplication

Obtains the configured HttpSecurityAutoWireSection.

Specified by:

getHttpSecurity in interface WebAutoWireApplication

Returns:

Configured HttpSecurityAutoWireSection or null if no HttpSecuritySource is configured.

addHttpApplicationObject

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

Description copied from interface: WebAutoWireApplication

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

Specified by:

addHttpApplicationObject in interface WebAutoWireApplication

Parameters:

objectClass - Class of the object.

bindName - Name to bind the object within the HttpApplicationState.

Returns:

AutoWireObject.

addHttpApplicationObject

public AutoWireObject addHttpApplicationObject(Class<?> objectClass)

Description copied from interface: WebAutoWireApplication

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 WebAutoWireApplication

Parameters:

objectClass - Class of the object.

Returns:

AutoWireObject.

addHttpSessionObject

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

Description copied from interface: WebAutoWireApplication

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

Specified by:

addHttpSessionObject in interface WebAutoWireApplication

Parameters:

objectClass - Class of the object.

bindName - Name to bind the object within the HttpSession.

Returns:

AutoWireObject.

addHttpSessionObject

public AutoWireObject addHttpSessionObject(Class<?> objectClass)

Description copied from interface: WebAutoWireApplication

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 WebAutoWireApplication

Parameters:

objectClass - Class of the object.

Returns:

AutoWireObject.

addHttpRequestObject

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

Description copied from interface: WebAutoWireApplication

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

Specified by:

addHttpRequestObject in interface WebAutoWireApplication

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:

AutoWireObject.

addHttpRequestObject

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

Description copied from interface: WebAutoWireApplication

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 WebAutoWireApplication

Parameters:

objectClass - Class of the object.

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

Returns:

AutoWireObject.

linkUri

public HttpUriLink linkUri(String uri,
                           AutoWireSection section,
                           String inputName)

Description copied from interface: WebAutoWireApplication

Links a URI to an OfficeSectionInput.

Specified by:

linkUri in interface WebAutoWireApplication

Parameters:

uri - URI to be linked.

section - AutoWireSection servicing the URI.

inputName - Name of the OfficeSectionInput servicing the URI.

Returns:

HttpUriLink to configure handling the URI.

linkToHttpTemplate

public void linkToHttpTemplate(AutoWireSection section,
                               String outputName,
                               HttpTemplateAutoWireSection template)

Description copied from interface: WebAutoWireApplication

Links the OfficeSectionOutput to render the HttpTemplate.

Specified by:

linkToHttpTemplate in interface WebAutoWireApplication

Parameters:

section - AutoWireSection.

outputName - Name of the OfficeSectionOutput.

template - HttpTemplateAutoWireSection.

linkToResource

public void linkToResource(AutoWireSection section,
                           String outputName,
                           String resourcePath)

Description copied from interface: WebAutoWireApplication

Links to a resource.

The meaning of resource path is specific to implementation.

Specified by:

linkToResource in interface WebAutoWireApplication

Parameters:

section - AutoWireSection.

outputName - Name of the OfficeSectionOutput.

resourcePath - Resource path.

linkEscalation

public void linkEscalation(Class<? extends Throwable> escalation,
                           HttpTemplateAutoWireSection template)

Description copied from interface: WebAutoWireApplication

Links the Escalation to be handled by the HttpTemplateAutoWireSection.

Specified by:

linkEscalation in interface WebAutoWireApplication

Parameters:

escalation - Escalation.

template - HttpTemplateAutoWireSection.

linkEscalation

public void linkEscalation(Class<? extends Throwable> escalation,
                           String resourcePath)

Description copied from interface: WebAutoWireApplication

Links the Escalation to be handled by the resource.

Specified by:

linkEscalation in interface WebAutoWireApplication

Parameters:

escalation - Escalation.

resourcePath - Resource path.

linkToSendResponse

public void linkToSendResponse(AutoWireSection section,
                               String outputName)

Description copied from interface: WebAutoWireApplication

Links OfficeSectionOutput to sending the HttpResponse.

Specified by:

linkToSendResponse in interface WebAutoWireApplication

Parameters:

section - AutoWireSection.

outputName - Name of the OfficeSectionOutput.

chainServicer

public void chainServicer(AutoWireSection section,
                          String inputName,
                          String notHandledOutputName)

Description copied from interface: WebAutoWireApplication

Chains a OfficeSectionInput to the end of the servicing chain to handle a HttpRequest.

The WebAutoWireApplication functionality is always the first in the chain to attempt to service the HttpRequest.

Typically the last in the chain is servicing the HttpRequest by sending a static resource by matching URI to resource name - and if no resource found, a not found error.

Specified by:

chainServicer in interface WebAutoWireApplication

Parameters:

section - AutoWireSection.

inputName - Name of the OfficeSectionInput.

notHandledOutputName - Name of the OfficeSectionOutput 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).

getURIs

public String[] getURIs()

Description copied from interface: WebAutoWireApplication

Obtains the linked URIs.

HttpTemplateAutoWireSection URIs are not included in this list. To determine if the HttpTemplateAutoWireSection is serviced (e.g. for embedding with a JEE server for Servlet mapping) use the template URI suffix.

Specified by:

getURIs in interface WebAutoWireApplication

Returns:

Linked URIs.

initOfficeFloor

protected void initOfficeFloor(OfficeFloorDeployer deployer,
                               OfficeFloorSourceContext context)
                        throws Exception

Description copied from class: AutoWireOfficeFloorSource

Allows overriding for initialising the OfficeFloor before auto-wiring.

Overrides:

initOfficeFloor in class AutoWireOfficeFloorSource

Parameters:

deployer - OfficeFloorDeployer.

context - OfficeFloorSourceContext.

Throws:

Exception - If fails to initialise.