Package net.officefloor.web.template.build

Interface WebTemplate

All Superinterfaces:

PropertyConfigurable

All Known Implementing Classes:

AbstractWebTemplate

public interface WebTemplate
extends PropertyConfigurable

Web template.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
WebTemplateExtensionBuilder	addExtension(java.lang.String webTemplateExtensionClassName)	Adds a WebTemplateExtension for this WebTemplate.
WebTemplate	addGovernance(OfficeGovernance governance)	Adds Governance for this WebTemplate.
WebTemplate	addRenderHttpMethod(java.lang.String httpMethodName)	Adds a HttpMethod that will render the WebTemplate.
HttpSecurableBuilder	getHttpSecurer()	Obtains the HttpSecurableBuilder to configure access controls to this WebTemplate.
OfficeFlowSourceNode	getOutput(java.lang.String outputName)	Obtains the OfficeFlowSourceNode from the WebTemplate.
OfficeFlowSinkNode	getRender(java.lang.String valuesTypeName)	Obtains the OfficeFlowSinkNode to render the WebTemplate.
WebTemplate	setCharset(java.lang.String charsetName)	Allow overriding the default Charset to render the WebTemplate.
WebTemplate	setContentType(java.lang.String contentType)	Specifies the Content-Type output by this WebTemplate.
WebTemplate	setLinkSecure(java.lang.String linkName, boolean isSecure)	Indicate whether a secure connection is required for the link.
WebTemplate	setLinkSeparatorCharacter(char separator)	Allows overriding the default separator character between the path and link.
WebTemplate	setLogicClass(java.lang.String logicClassName)	Specifies the logic Class.
WebTemplate	setRedirectValuesFunction(java.lang.String functionName)	Specifies the Method name on the logic Class to provide the values for redirect path parameters to this WebTemplate.
WebTemplate	setSuperTemplate(WebTemplate superTemplate)	Specifies the super (parent) WebTemplate.

Methods inherited from interface net.officefloor.compile.properties.PropertyConfigurable

addProperty

Method Detail

setLogicClass

WebTemplate setLogicClass(java.lang.String logicClassName)

Specifies the logic Class.

Parameters:

logicClassName - Name of the logic Class.

Returns:

this.

setRedirectValuesFunction

WebTemplate setRedirectValuesFunction(java.lang.String functionName)

Specifies the Method name on the logic Class to provide the values for redirect path parameters to this WebTemplate. The returned type from the Method will be used to source values for parameters in constructing the path to this WebTemplate.

Should the path to the template be static (i.e. has no path parameters), no Method need be specified.

Parameters:

functionName - Logic Class Method name.

Returns:

this.

setContentType

WebTemplate setContentType(java.lang.String contentType)

Specifies the Content-Type output by this WebTemplate.

Parameters:

contentType - Content-Type output by this WebTemplate.

Returns:

this.

setCharset

WebTemplate setCharset(java.lang.String charsetName)

Allow overriding the default Charset to render the WebTemplate.

Parameters:

charsetName - Name of Charset to render the WebTemplate.

Returns:

this.

setLinkSeparatorCharacter

WebTemplate setLinkSeparatorCharacter(char separator)

Allows overriding the default separator character between the path and link.

Parameters:

separator - Separator to use to separate path and link.

Returns:

this.

setLinkSecure

WebTemplate setLinkSecure(java.lang.String linkName,
                          boolean isSecure)

Indicate whether a secure connection is required for the link. This overrides the default template secure setting for the link.

Example use could be the landing page may be insecure but the login form submission link on the page is to be secure.

Parameters:

linkName - Name of link to secure.

isSecure - true should the link require a secure ServerHttpConnection.

Returns:

this.

getHttpSecurer

HttpSecurableBuilder getHttpSecurer()

Obtains the HttpSecurableBuilder to configure access controls to this WebTemplate.

Calling this method without providing configuration requires only authentication to access the WebTemplate.

Returns:

HttpSecurableBuilder.

addRenderHttpMethod

WebTemplate addRenderHttpMethod(java.lang.String httpMethodName)

Adds a HttpMethod that will render the WebTemplate. Should the HttpMethod not be in this list, a redirect will occur to HttpMethod.HttpMethodEnum.GET.

Note that HttpMethod.HttpMethodEnum.GET is added by default.

Parameters:

httpMethodName - Name of the HttpMethod that will render the WebTemplate.

Returns:

this.

setSuperTemplate

WebTemplate setSuperTemplate(WebTemplate superTemplate)

Specifies the super (parent) WebTemplate.

Parameters:

superTemplate - Super WebTemplate.

Returns:

this.

addExtension

WebTemplateExtensionBuilder addExtension(java.lang.String webTemplateExtensionClassName)

Adds a WebTemplateExtension for this WebTemplate.

Parameters:

webTemplateExtensionClassName - WebTemplateExtension Class name.

Returns:

WebTemplateExtensionBuilder to build the WebTemplateExtension.

getRender

OfficeFlowSinkNode getRender(java.lang.String valuesTypeName)

Obtains the OfficeFlowSinkNode to render the WebTemplate.

Parameters:

valuesTypeName - Name of type provided as a parameter to the OfficeFlowSinkNode should the path parameters require being obtained. The type should provide a bean property for each path parameter for the WebTemplate. May be null if no path parameters are required.

Returns:

OfficeFlowSinkNode to render the WebTemplate.

getOutput

OfficeFlowSourceNode getOutput(java.lang.String outputName)

Obtains the OfficeFlowSourceNode from the WebTemplate.

Parameters:

outputName - OfficeFlowSourceNode name.

Returns:

OfficeFlowSourceNode for the name.

addGovernance

WebTemplate addGovernance(OfficeGovernance governance)

Adds Governance for this WebTemplate.

This enables providing Governance over all OfficeSectionFunction instances within the WebTemplate and all its subsequent OfficeSubSection instances.

Parameters:

governance - OfficeGovernance.

Returns:

this.