net.officefloor.plugin.web.http.application

Class HttpTemplateAutoWireSectionImpl

java.lang.Object

net.officefloor.autowire.impl.AutoWirePropertiesImpl

net.officefloor.autowire.impl.AutoWireSectionImpl

net.officefloor.plugin.web.http.application.HttpTemplateAutoWireSectionImpl

All Implemented Interfaces:

AutoWireProperties, AutoWireSection, PropertyConfigurable, HttpTemplateAutoWireSection

public class HttpTemplateAutoWireSectionImpl
extends AutoWireSectionImpl
implements HttpTemplateAutoWireSection

Allows wiring the flows of the HttpTemplate.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class net.officefloor.autowire.impl.AutoWirePropertiesImpl

ENVIRONMENT_PROPERTIES_DIRECTORY

Fields inherited from interface net.officefloor.autowire.AutoWireProperties

ENVIRONMENT_PROPERTIES_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
HttpTemplateAutoWireSectionImpl(OfficeFloorCompiler compiler, AutoWireSection section, Class<?> templateLogicClass, String templateUri) Initiate.

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 class net.officefloor.autowire.impl.AutoWireSectionImpl

getSectionLocation, getSectionName, getSectionSourceClassName, getSuperSection, setSuperSection

Methods inherited from class net.officefloor.autowire.impl.AutoWirePropertiesImpl

addProperty, getProperties, loadProperties

Methods inherited from class java.lang.Object

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

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

Constructor Detail

HttpTemplateAutoWireSectionImpl

public HttpTemplateAutoWireSectionImpl(OfficeFloorCompiler compiler,
                                       AutoWireSection section,
                                       Class<?> templateLogicClass,
                                       String templateUri)

Initiate.

Parameters:

compiler - OfficeFloorCompiler.

section - AutoWireSection.

templateLogicClass - Logic class for the template.

templateUri - URI to the template. May be null if not publicly exposed template.

Method Detail

getTemplatePath

public String getTemplatePath()

Description copied from interface: HttpTemplateAutoWireSection

Obtains path to the template file.

Specified by:

getTemplatePath in interface HttpTemplateAutoWireSection

Returns:

Path to the template file.

getTemplateLogicClass

public Class<?> getTemplateLogicClass()

Description copied from interface: HttpTemplateAutoWireSection

Obtains the logic class for the template.

Specified by:

getTemplateLogicClass in interface HttpTemplateAutoWireSection

Returns:

Logic class for the template.

getTemplateUri

public String getTemplateUri()

Description copied from interface: HttpTemplateAutoWireSection

Obtains the URI to the template.

Specified by:

getTemplateUri in interface HttpTemplateAutoWireSection

Returns:

URI to the template.

setTemplateUriSuffix

public void setTemplateUriSuffix(String uriSuffix)

Description copied from interface: HttpTemplateAutoWireSection

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.

Specified by:

setTemplateUriSuffix in interface HttpTemplateAutoWireSection

Parameters:

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

getTemplateUriSuffix

public String getTemplateUriSuffix()

Description copied from interface: HttpTemplateAutoWireSection

Obtains the template URI suffix.

Specified by:

getTemplateUriSuffix in interface HttpTemplateAutoWireSection

Returns:

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

setTemplateContentType

public void setTemplateContentType(String contentType)

Description copied from interface: HttpTemplateAutoWireSection

Specifies the Content-Type for the template.

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

Specified by:

setTemplateContentType in interface HttpTemplateAutoWireSection

Parameters:

contentType - Content-Type for the template.

getTemplateContentType

public String getTemplateContentType()

Description copied from interface: HttpTemplateAutoWireSection

Obtains the Content-Type for the template.

Specified by:

getTemplateContentType in interface HttpTemplateAutoWireSection

Returns:

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

setTemplateSecure

public void setTemplateSecure(boolean isSecure)

Description copied from interface: HttpTemplateAutoWireSection

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)

Specified by:

setTemplateSecure in interface HttpTemplateAutoWireSection

Parameters:

isSecure - true should the AutoWireSection require a secure ServerHttpConnection.

isTemplateSecure

public boolean isTemplateSecure()

Description copied from interface: HttpTemplateAutoWireSection

Indicates whether a secure ServerHttpConnection is required for the template.

Specified by:

isTemplateSecure in interface HttpTemplateAutoWireSection

Returns:

true if a secure ServerHttpConnection is required for the template.

setLinkSecure

public void setLinkSecure(String linkName,
                          boolean isSecure)

Description copied from interface: HttpTemplateAutoWireSection

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.

Specified by:

setLinkSecure in interface HttpTemplateAutoWireSection

Parameters:

linkName - Name of link to secure.

isSecure - true should the link require a secure ServerHttpConnection.

getSecureLinks

public Map<String,Boolean> getSecureLinks()

Description copied from interface: HttpTemplateAutoWireSection

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.

Specified by:

getSecureLinks in interface HttpTemplateAutoWireSection

Returns:

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

addRenderRedirectHttpMethod

public void addRenderRedirectHttpMethod(String renderRedirectHttpMethod)

Description copied from interface: HttpTemplateAutoWireSection

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.

Specified by:

addRenderRedirectHttpMethod in interface HttpTemplateAutoWireSection

Parameters:

renderRedirectHttpMethod - HTTP method.

getRenderRedirectHttpMethods

public String[] getRenderRedirectHttpMethods()

Description copied from interface: HttpTemplateAutoWireSection

Obtains the configured render redirect HTTP methods.

Specified by:

getRenderRedirectHttpMethods in interface HttpTemplateAutoWireSection

Returns:

Configured render redirect HTTP methods.

addTemplateExtension

public HttpTemplateAutoWireSectionExtension addTemplateExtension(Class<? extends HttpTemplateSectionExtension> extensionClass)

Description copied from interface: HttpTemplateAutoWireSection

Adds an HttpTemplateSectionExtension to this HttpTemplateAutoWireSection.

Specified by:

addTemplateExtension in interface HttpTemplateAutoWireSection

Parameters:

extensionClass - Class of the HttpTemplateSectionExtension.

Returns:

HttpTemplateAutoWireSectionExtension.