net.officefloor.plugin.web.http.application

Interface HttpTemplateAutoWireSection

All Superinterfaces:

AutoWireProperties, AutoWireSection, PropertyConfigurable

All Known Implementing Classes:

HttpTemplateAutoWireSectionImpl

public interface HttpTemplateAutoWireSection
extends AutoWireSection

Allows wiring the flows of the HttpTemplate.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.autowire.AutoWireProperties

ENVIRONMENT_PROPERTIES_DIRECTORY

Method Summary

Modifier and Type	Method and Description
void	addRenderRedirectHttpMethod(String renderRedirectHttpMethod) Adds a HTTP method that will cause a redirect on rendering this HttpTemplate.
HttpTemplateAutoWireSectionExtension	addTemplateExtension(Class<? extends HttpTemplateSectionExtension> extensionClass) Adds an HttpTemplateSectionExtension to this HttpTemplateAutoWireSection.
String[]	getRenderRedirectHttpMethods() Obtains the configured render redirect HTTP methods.
Map<String,Boolean>	getSecureLinks() Obtains an immutable Map providing the overriding configuration of whether a link requires a secure ServerHttpConnection.
String	getTemplateContentType() Obtains the Content-Type for the template.
Class<?>	getTemplateLogicClass() Obtains the logic class for the template.
String	getTemplatePath() Obtains path to the template file.
String	getTemplateUri() Obtains the URI to the template.
String	getTemplateUriSuffix() Obtains the template URI suffix.
boolean	isTemplateSecure() Indicates whether a secure ServerHttpConnection is required for the template.
void	setLinkSecure(String linkName, boolean isSecure) Indicate whether a secure ServerHttpConnection is required for the link.
void	setTemplateContentType(String contentType) Specifies the Content-Type for the template.
void	setTemplateSecure(boolean isSecure) Indicate whether a secure ServerHttpConnection is required for the template.
void	setTemplateUriSuffix(String uriSuffix) Specifies the template URI suffix.

Methods inherited from interface net.officefloor.autowire.AutoWireSection

getSectionLocation, getSectionName, getSectionSourceClassName, getSuperSection, setSuperSection

Methods inherited from interface net.officefloor.autowire.AutoWireProperties

getProperties, loadProperties

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

addProperty

Method Detail

getTemplateUri

String getTemplateUri()

Obtains the URI to the template.

Returns:

URI to the template.

getTemplatePath

String getTemplatePath()

Obtains path to the template file.

Returns:

Path to the template file.

getTemplateLogicClass

Class<?> getTemplateLogicClass()

Obtains the logic class for the template.

Returns:

Logic class for the template.

setTemplateUriSuffix

void setTemplateUriSuffix(String uriSuffix)

Specifies the template URI suffix.

This is appended to the template URI and link URIs. It is useful to provide a ".extension" to the template URIs.

Parameters:

uriSuffix - Template URI suffix. May be null to not have a URI suffix.

getTemplateUriSuffix

String getTemplateUriSuffix()

Obtains the template URI suffix.

Returns:

Template URI suffix. May be null to not have a URI suffix.

setTemplateContentType

void setTemplateContentType(String contentType)

Specifies the Content-Type for the template.

Note for text/* values, the charset parameter will be respected in generating the template.

Parameters:

contentType - Content-Type for the template.

getTemplateContentType

String getTemplateContentType()

Obtains the Content-Type for the template.

Returns:

Content-Type for the template. May be null to use the default encoding.

setTemplateSecure

void setTemplateSecure(boolean isSecure)

Indicate whether a secure ServerHttpConnection is required for the template. This applies to:

• all links for the HttpTemplateAutoWireSection
• rendering of the HttpTemplateAutoWireSection response (a redirect will be triggered if not appropriately secure)

Parameters:

isSecure - true should the AutoWireSection require a secure ServerHttpConnection.

isTemplateSecure

boolean isTemplateSecure()

Indicates whether a secure ServerHttpConnection is required for the template.

Returns:

true if a secure ServerHttpConnection is required for the template.

setLinkSecure

void setLinkSecure(String linkName,
                   boolean isSecure)

Indicate whether a secure ServerHttpConnection 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.

getSecureLinks

Map<String,Boolean> getSecureLinks()

Obtains an immutable Map providing the overriding configuration of whether a link requires a secure ServerHttpConnection.

Links not contained in the returned Map will default secure to that of the template.

Returns:

Immutable Map of link to whether if requires a secure ServerHttpConnection.

addRenderRedirectHttpMethod

void addRenderRedirectHttpMethod(String renderRedirectHttpMethod)

Adds a HTTP method that will cause a redirect on rendering this HttpTemplate.

This allows specifying the HTTP methods that will follow the POST/redirect/GET pattern.

Parameters:

renderRedirectHttpMethod - HTTP method.

getRenderRedirectHttpMethods

String[] getRenderRedirectHttpMethods()

Obtains the configured render redirect HTTP methods.

Returns:

Configured render redirect HTTP methods.

addTemplateExtension

HttpTemplateAutoWireSectionExtension addTemplateExtension(Class<? extends HttpTemplateSectionExtension> extensionClass)

Adds an HttpTemplateSectionExtension to this HttpTemplateAutoWireSection.

Parameters:

extensionClass - Class of the HttpTemplateSectionExtension.

Returns:

HttpTemplateAutoWireSectionExtension.