Package net.officefloor.web

Class HttpRouteSectionSource

java.lang.Object

net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

net.officefloor.web.HttpRouteSectionSource

All Implemented Interfaces:

SectionSource

@PrivateSource
public class HttpRouteSectionSource
extends AbstractSectionSource

SectionSource to handle HTTP routing.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpRouteSectionSource.Interception	Obtains the interception details.
static class	HttpRouteSectionSource.Redirect	Redirect.
static class	HttpRouteSectionSource.RouteInput	Route input information.

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

AbstractSectionSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NOT_FOUND_INPUT_NAME	Name of SectionInput for not found resource.
static final String	UNHANDLED_OUTPUT_NAME	Name of SectionOutput for unhandled HttpRequest.

Constructor Summary

Constructors

Constructor	Description
HttpRouteSectionSource(String contextPath)	Instantiate.

Method Summary

Modifier and Type	Method	Description
HttpRouteSectionSource.Redirect	addRedirect(boolean isSecure, HttpRouteSectionSource.RouteInput routeInput, Class<?> parameterType)	Adds a HttpRouteSectionSource.Redirect.
HttpRouteSectionSource.RouteInput	addRoute(boolean isSecure, HttpMethod method, String path)	Adds a route.
HttpRouteSectionSource.Interception	getInterception()	Obtains the HttpRouteSectionSource.Interception.
boolean	isPathParameters(String path)	Indicates if the path contains parameters.
protected void	loadSpecification(AbstractSectionSource.SpecificationContext context)	Loads the SectionSourceSpecification.
void	setHttpEscalationHandler(HttpEscalationHandler escalationHandler)	Specifies the HttpEscalationHandler
void	sourceSection(SectionDesigner designer, SectionSourceContext context)	Sources the OfficeSection by constructing it via the input SectionDesigner.

Methods inherited from class net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Details

UNHANDLED_OUTPUT_NAME

public static final String UNHANDLED_OUTPUT_NAME

Name of SectionOutput for unhandled HttpRequest.

See Also:

• Constant Field Values

NOT_FOUND_INPUT_NAME

public static final String NOT_FOUND_INPUT_NAME

Name of SectionInput for not found resource.

See Also:

• Constant Field Values

Constructor Details

HttpRouteSectionSource

public HttpRouteSectionSource(String contextPath)

Instantiate.

Parameters:

contextPath - Context path. May be null.

Method Details

setHttpEscalationHandler

public void setHttpEscalationHandler(HttpEscalationHandler escalationHandler)

Specifies the HttpEscalationHandler

Parameters:

escalationHandler - HttpEscalationHandler. May be null.

getInterception

public HttpRouteSectionSource.Interception getInterception()

Obtains the HttpRouteSectionSource.Interception.

Returns:

HttpRouteSectionSource.Interception.

isPathParameters

public boolean isPathParameters(String path)

Indicates if the path contains parameters.

Parameters:

path - Path.

Returns:

true should the path contain parameters.

addRoute

public HttpRouteSectionSource.RouteInput addRoute(boolean isSecure,
 HttpMethod method,
 String path)

Adds a route.

Parameters:

isSecure - Indicates if a secure connection is required for the route.

method - HttpMethod.

path - Route path.

Returns:

HttpRouteSectionSource.RouteInput for the route.

addRedirect

public HttpRouteSectionSource.Redirect addRedirect(boolean isSecure,
 HttpRouteSectionSource.RouteInput routeInput,
 Class<?> parameterType)
                                            throws Exception

Adds a HttpRouteSectionSource.Redirect.

Parameters:

isSecure - Indicates to redirect to a secure port.

routeInput - HttpRouteSectionSource.RouteInput to redirect to.

parameterType - Type of parameter passed to the redirect ManagedFunction to source values for constructing the path. May be null.

Returns:

HttpRouteSectionSource.Redirect.

Throws:

Exception - If fails to add the redirect.

loadSpecification

protected void loadSpecification(AbstractSectionSource.SpecificationContext context)

Description copied from class: AbstractSectionSource

Loads the SectionSourceSpecification.

Specified by:

loadSpecification in class AbstractSectionSource

Parameters:

context - AbstractSectionSource.SpecificationContext.

sourceSection

public void sourceSection(SectionDesigner designer,
 SectionSourceContext context)
                   throws Exception

Description copied from interface: SectionSource

Sources the OfficeSection by constructing it via the input SectionDesigner.

Parameters:

designer - SectionDesigner to construct the structure of the OfficeSection.

context - SectionSourceContext to source details to construct the OfficeSection.

Throws:

Exception - If fails to construct the OfficeSection.