Package net.officefloor.web.template.section

Class WebTemplateSectionSource

java.lang.Object

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

net.officefloor.web.template.section.WebTemplateSectionSource

All Implemented Interfaces:

SectionSource

@PrivateSource
public class WebTemplateSectionSource
extends AbstractSectionSource

SectionSource for the HTTP template.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WebTemplateSectionSource.NoLogicClass	No-logic placeholder class for ClassSectionSource.
static class	WebTemplateSectionSource.SectionWriterStruct	Section WebTemplateWriter struct.
static class	WebTemplateSectionSource.WebTemplateManagedFunctionSource	ManagedFunctionSource for the HTTP template.

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	ON_COMPLETION_OUTPUT_NAME	Name of the SectionOutput for flow after completion of rending the ParsedTemplate.
static final String	OVERRIDE_SECTION_PREFIX	Prefix on a ParsedTemplateSection name to indicate it is an override section.
static final String	PROPERTY_BEAN_PREFIX	Property prefix to obtain the bean for the ParsedTemplateSection.
static final String	PROPERTY_CHARSET	Name of Property for the Charset of the ParsedTemplate.
static final String	PROPERTY_CLASS_NAME	Name of Property for the Class providing the backing logic to the template.
static final String	PROPERTY_CONTENT_TYPE	Name of Property for the Content-Type of the ParsedTemplate.
static final String	PROPERTY_INHERITED_TEMPLATES_COUNT	Name of Property for the number of inherited templates.
static final String	PROPERTY_IS_PATH_PARAMETERS	Name of Property to indicate if this WebTemplate contains HttpPathParameter instances (dynamic path).
static final String	PROPERTY_LINK_SECURE_PREFIX	Property prefix to obtain whether the link is to be secure.
static final String	PROPERTY_LINK_SEPARATOR	Name of Property to obtain the link separator.
static final String	PROPERTY_REDIRECT_VALUES_FUNCTION	Name of Property for the Method name on the logic Class that will return an object containing the values for the path parameters in redirecting to this WebTemplate.
static final String	PROPERTY_TEMPLATE_CONTENT	Name of Property to obtain the raw ParsedTemplate content.
static final String	PROPERTY_TEMPLATE_LOCATION	Name of Property providing the location of the WebTemplate content.
static final String	PROPERTY_TEMPLATE_LOCATION_CHARSET	Name of Property providing the Charset to read in the WebTemplate content at the configured PROPERTY_TEMPLATE_LOCATION.
static final String	PROPERTY_TEMPLATE_SECURE	Name of Property to indicate if the ParsedTemplate requires a secure ServerHttpConnection.
static final String	REDIRECT_TEMPLATE_OUTPUT_NAME	Name of the SectionOutput for redirect to the WebTemplate.
static final String	RENDER_TEMPLATE_INPUT_NAME	Name of the SectionInput for rendering this ParsedTemplate.

Constructor Summary

Constructors

Constructor	Description
WebTemplateSectionSource()

Method Summary

Modifier and Type	Method	Description
WebTemplateExtensionBuilder	addWebTemplateExtension(String webtemplateExtensionClassName, PropertyList propertyList)	Adds a WebTemplateExtensionBuilder.
protected void	loadSpecification(AbstractSectionSource.SpecificationContext context)	Loads the SectionSourceSpecification.
void	setHttpInputPath(HttpInputPath inputPath)	Specifies the HttpInputPath.
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

RENDER_TEMPLATE_INPUT_NAME

public static final String RENDER_TEMPLATE_INPUT_NAME

Name of the SectionInput for rendering this ParsedTemplate.

See Also:

• Constant Field Values

REDIRECT_TEMPLATE_OUTPUT_NAME

public static final String REDIRECT_TEMPLATE_OUTPUT_NAME

Name of the SectionOutput for redirect to the WebTemplate.

See Also:

• Constant Field Values

ON_COMPLETION_OUTPUT_NAME

public static final String ON_COMPLETION_OUTPUT_NAME

Name of the SectionOutput for flow after completion of rending the ParsedTemplate.

See Also:

• Constant Field Values

OVERRIDE_SECTION_PREFIX

public static final String OVERRIDE_SECTION_PREFIX

Prefix on a ParsedTemplateSection name to indicate it is an override section.

See Also:

• Constant Field Values

PROPERTY_INHERITED_TEMPLATES_COUNT

public static final String PROPERTY_INHERITED_TEMPLATES_COUNT

Name of Property for the number of inherited templates.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_CONTENT

public static final String PROPERTY_TEMPLATE_CONTENT

Name of Property to obtain the raw ParsedTemplate content.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_LOCATION

public static final String PROPERTY_TEMPLATE_LOCATION

Name of Property providing the location of the WebTemplate content.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_LOCATION_CHARSET

public static final String PROPERTY_TEMPLATE_LOCATION_CHARSET

Name of Property providing the Charset to read in the WebTemplate content at the configured PROPERTY_TEMPLATE_LOCATION.

See Also:

• Constant Field Values

PROPERTY_CLASS_NAME

public static final String PROPERTY_CLASS_NAME

Name of Property for the Class providing the backing logic to the template.

See Also:

• Constant Field Values

PROPERTY_IS_PATH_PARAMETERS

public static final String PROPERTY_IS_PATH_PARAMETERS

Name of Property to indicate if this WebTemplate contains HttpPathParameter instances (dynamic path).

Note that specifying the HttpInputPath overrides this configured value.

See Also:

• Constant Field Values

PROPERTY_REDIRECT_VALUES_FUNCTION

public static final String PROPERTY_REDIRECT_VALUES_FUNCTION

Name of Property for the Method name on the logic Class that will return an object containing the values for the path parameters in redirecting to this WebTemplate.

See Also:

• Constant Field Values

PROPERTY_BEAN_PREFIX

public static final String PROPERTY_BEAN_PREFIX

Property prefix to obtain the bean for the ParsedTemplateSection.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_SECURE

public static final String PROPERTY_TEMPLATE_SECURE

Name of Property to indicate if the ParsedTemplate requires a secure ServerHttpConnection.

See Also:

• Constant Field Values

PROPERTY_LINK_SECURE_PREFIX

public static final String PROPERTY_LINK_SECURE_PREFIX

Property prefix to obtain whether the link is to be secure.

See Also:

• Constant Field Values

PROPERTY_LINK_SEPARATOR

public static final String PROPERTY_LINK_SEPARATOR

Name of Property to obtain the link separator.

See Also:

• Constant Field Values

PROPERTY_CONTENT_TYPE

public static final String PROPERTY_CONTENT_TYPE

Name of Property for the Content-Type of the ParsedTemplate.

See Also:

• Constant Field Values

PROPERTY_CHARSET

public static final String PROPERTY_CHARSET

Name of Property for the Charset of the ParsedTemplate.

See Also:

• Constant Field Values

Constructor Details

WebTemplateSectionSource

public WebTemplateSectionSource()

Method Details

setHttpInputPath

public void setHttpInputPath(HttpInputPath inputPath)

Specifies the HttpInputPath.

Parameters:

inputPath - HttpInputPath.

addWebTemplateExtension

public WebTemplateExtensionBuilder addWebTemplateExtension(String webtemplateExtensionClassName,
 PropertyList propertyList)

Adds a WebTemplateExtensionBuilder.

Parameters:

webtemplateExtensionClassName - WebTemplateExtension Class name.

propertyList - PropertyList.

Returns:

WebTemplateExtensionBuilder.

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.