Package net.officefloor.web.template.build

Class AbstractWebTemplate

java.lang.Object

net.officefloor.web.template.build.AbstractWebTemplate

All Implemented Interfaces:

PropertyConfigurable, WebTemplate

public abstract class AbstractWebTemplate
extends Object
implements WebTemplate

Abstract WebTemplate.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	applicationPath	Application path for the WebTemplate.
protected String	charsetName	Name of the Charset.
protected String	contentType	Content-Type for the WebTemplate.
protected final boolean	isSecure	Indicates if the WebTemplate is secure.
protected char	linkSeparatorCharacter	Link separator character.
protected String	logicClassName	Name of the logic Class for the WebTemplate.
protected String	redirectValuesFunctionName	Name of Method on the logic Class to return the values for path parameters in redirecting to this WebTemplate.
protected final List<String>	renderHttpMethodNames	Render HttpMethod names.
protected Map<String,Boolean>	secureLinks	Secure links.
protected AbstractWebTemplate	superTemplate	Super WebTemplate.
protected final WebTemplateSectionSource	webTemplateSectionSource	WebTemplateSectionSource.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWebTemplate(WebTemplateSectionSource webTemplateSectionSource, boolean isSecure, String applicationPath, PropertyList properties, SourceIssues sourceIssues)	Instantiate.

Method Summary

Modifier and Type	Method	Description
WebTemplateExtensionBuilder	addExtension(String webTemplateExtensionClassName)	Adds a WebTemplateExtension for this WebTemplate.
void	addProperty(String name, String value)	Adds a Property to configure the item.
WebTemplate	addRenderHttpMethod(String httpMethodName)	Adds a HttpMethod that will render the WebTemplate.
protected abstract PropertyList	createPropertyList()	Creates a new PropertyList.
String	getApplicationPath()	Obtains the application path.
HttpSecurableBuilder	getHttpSecurer()	Obtains the HttpSecurableBuilder to configure access controls to this WebTemplate.
WebTemplateSectionSource	getWebTemplateSectionSource()	Obtains the WebTemplateSectionSource.
PropertyList	loadProperties(boolean isPathParameters)	Loads the properties.
WebTemplate	setCharset(String charsetName)	Allow overriding the default Charset to render the WebTemplate.
WebTemplate	setContentType(String contentType)	Specifies the Content-Type output by this WebTemplate.
WebTemplate	setLinkSecure(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(String logicClassName)	Specifies the logic Class.
WebTemplate	setRedirectValuesFunction(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 class java.lang.Object

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

Methods inherited from interface net.officefloor.web.template.build.WebTemplate

addGovernance, getOutput, getRender

Field Details

webTemplateSectionSource

protected final WebTemplateSectionSource webTemplateSectionSource

WebTemplateSectionSource.

isSecure

protected final boolean isSecure

Indicates if the WebTemplate is secure.

applicationPath

protected final String applicationPath

Application path for the WebTemplate.

logicClassName

protected String logicClassName

Name of the logic Class for the WebTemplate.

redirectValuesFunctionName

protected String redirectValuesFunctionName

Name of Method on the logic Class to return the values for path parameters in redirecting to this WebTemplate.

secureLinks

protected Map<String,Boolean> secureLinks

Secure links.

linkSeparatorCharacter

protected char linkSeparatorCharacter

Link separator character.

contentType

protected String contentType

Content-Type for the WebTemplate.

charsetName

protected String charsetName

Name of the Charset.

renderHttpMethodNames

protected final List<String> renderHttpMethodNames

Render HttpMethod names.

superTemplate

protected AbstractWebTemplate superTemplate

Super WebTemplate.

Constructor Details

AbstractWebTemplate

protected AbstractWebTemplate(WebTemplateSectionSource webTemplateSectionSource,
 boolean isSecure,
 String applicationPath,
 PropertyList properties,
 SourceIssues sourceIssues)

Instantiate.

Parameters:

webTemplateSectionSource - WebTemplateSectionSource instance to use.

isSecure - Indicates if requires secure ServerHttpConnection to render the WebTemplate.

applicationPath - Application path for the WebTemplate.

properties - PropertyList.

sourceIssues - SourceIssues.

Method Details

createPropertyList

protected abstract PropertyList createPropertyList()

Creates a new PropertyList.

Returns:

New PropertyList.

getApplicationPath

public String getApplicationPath()

Obtains the application path.

Returns:

Application path.

getWebTemplateSectionSource

public WebTemplateSectionSource getWebTemplateSectionSource()

Obtains the WebTemplateSectionSource.

Returns:

WebTemplateSectionSource.

loadProperties

public PropertyList loadProperties(boolean isPathParameters)

Loads the properties.

Parameters:

isPathParameters - Indicates if path parameters.

Returns:

PropertyList.

addProperty

public void addProperty(String name,
 String value)

Description copied from interface: PropertyConfigurable

Adds a Property to configure the item.

Specified by:

addProperty in interface PropertyConfigurable

Parameters:

name - Name of Property.

value - Value of Property.

setLogicClass

public WebTemplate setLogicClass(String logicClassName)

Description copied from interface: WebTemplate

Specifies the logic Class.

Specified by:

setLogicClass in interface WebTemplate

Parameters:

logicClassName - Name of the logic Class.

Returns:

this.

setRedirectValuesFunction

public WebTemplate setRedirectValuesFunction(String functionName)

Description copied from interface: WebTemplate

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.

Specified by:

setRedirectValuesFunction in interface WebTemplate

Parameters:

functionName - Logic Class Method name.

Returns:

this.

setContentType

public WebTemplate setContentType(String contentType)

Description copied from interface: WebTemplate

Specifies the Content-Type output by this WebTemplate.

Specified by:

setContentType in interface WebTemplate

Parameters:

contentType - Content-Type output by this WebTemplate.

Returns:

this.

setCharset

public WebTemplate setCharset(String charsetName)

Description copied from interface: WebTemplate

Allow overriding the default Charset to render the WebTemplate.

Specified by:

setCharset in interface WebTemplate

Parameters:

charsetName - Name of Charset to render the WebTemplate.

Returns:

this.

setLinkSeparatorCharacter

public WebTemplate setLinkSeparatorCharacter(char separator)

Description copied from interface: WebTemplate

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

Specified by:

setLinkSeparatorCharacter in interface WebTemplate

Parameters:

separator - Separator to use to separate path and link.

Returns:

this.

setLinkSecure

public WebTemplate setLinkSecure(String linkName,
 boolean isSecure)

Description copied from interface: WebTemplate

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.

Specified by:

setLinkSecure in interface WebTemplate

Parameters:

linkName - Name of link to secure.

isSecure - true should the link require a secure ServerHttpConnection.

Returns:

this.

getHttpSecurer

public HttpSecurableBuilder getHttpSecurer()

Description copied from interface: WebTemplate

Obtains the HttpSecurableBuilder to configure access controls to this WebTemplate.

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

Specified by:

getHttpSecurer in interface WebTemplate

Returns:

HttpSecurableBuilder.

addRenderHttpMethod

public WebTemplate addRenderHttpMethod(String httpMethodName)

Description copied from interface: WebTemplate

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.

Specified by:

addRenderHttpMethod in interface WebTemplate

Parameters:

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

Returns:

this.

setSuperTemplate

public WebTemplate setSuperTemplate(WebTemplate superTemplate)

Description copied from interface: WebTemplate

Specifies the super (parent) WebTemplate.

Specified by:

setSuperTemplate in interface WebTemplate

Parameters:

superTemplate - Super WebTemplate.

Returns:

this.

addExtension

public WebTemplateExtensionBuilder addExtension(String webTemplateExtensionClassName)

Description copied from interface: WebTemplate

Adds a WebTemplateExtension for this WebTemplate.

Specified by:

addExtension in interface WebTemplate

Parameters:

webTemplateExtensionClassName - WebTemplateExtension Class name.

Returns:

WebTemplateExtensionBuilder to build the WebTemplateExtension.