net.officefloor.eclipse.wizard.template

Class HttpTemplateInstance

java.lang.Object

net.officefloor.eclipse.wizard.template.HttpTemplateInstance

public class HttpTemplateInstance
extends Object

Instance of the HttpTemplate.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpTemplateInstance(String woofTemplateName, String uri, String templatePath, String logicClassName, SectionType sectionType, WoofTemplateModel superTemplate, Set<String> inheritedTemplateOutputNames, String contentType, boolean isTemplateSecure, Map<String,Boolean> linksSecure, String[] renderRedirectHttpMethods, boolean isContinueRendering, HttpTemplateExtensionInstance[] extensionInstances) Initiate.
HttpTemplateInstance(WoofTemplateModel template, WoofChanges changes) Initiate deriving details from WoofTemplateModel.

Method Summary

Modifier and Type	Method and Description
String	getContentType() Obtains the Content-Type for the WoofTemplateModel.
Set<String>	getInheritedTemplateOutputNames() Obtains the names of the WoofTemplateOutputModel instances that are inheriting their configuration.
Map<String,Boolean>	getLinksSecure() Obtains the mapping of secure for HttpTemplate links.
String	getLogicClassName() Obtains the name of the logic class for the HttpTemplate.
Map<String,String>	getOutputNameMapping() Obtains the mapping of refactored SectionOutputType name to existing WoofTemplateOutputModel name.
String[]	getRenderRedirectHttpMethods() Obtains the HTTP methods that will trigger a redirect on rendering the HttpTemplate.
WoofTemplateModel	getSuperTemplate() Obtains the super WoofTemplateModel.
HttpTemplateExtensionInstance[]	getTemplateExtensionInstances() Obtains the HttpTemplateExtensionInstance listing.
String[]	getTemplateOutputNames() Obtains the WoofTemplateOutputModel names on the WoofTemplateModel being refactored.
String	getTemplatePath() Obtains the path to the HttpTemplate.
SectionType	getTemplateSectionType() Obtains the SectionType.
String	getUri() Obtains the URI.
WoofTemplateExtension[]	getWoofTemplateExtensions() Obtains the WoofTemplateExtension instances.
String	getWoofTemplateName() Obtains the WoofTemplateModel name.
boolean	isContinueRendering() Indicates if may continue rendering.
boolean	isTemplateSecure() Obtains whether the HttpTemplate requires a secure ServerHttpConnection.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpTemplateInstance

public HttpTemplateInstance(String woofTemplateName,
                            String uri,
                            String templatePath,
                            String logicClassName,
                            SectionType sectionType,
                            WoofTemplateModel superTemplate,
                            Set<String> inheritedTemplateOutputNames,
                            String contentType,
                            boolean isTemplateSecure,
                            Map<String,Boolean> linksSecure,
                            String[] renderRedirectHttpMethods,
                            boolean isContinueRendering,
                            HttpTemplateExtensionInstance[] extensionInstances)

Initiate.

Parameters:

woofTemplateName - WoofTemplateModel name.

uri - URI.

templatePath - Path to the HttpTemplate.

logicClassName - Name of the logic class.

sectionType - SectionType.

superTemplate - Super WoofTemplateModel. May be null if not inheriting.

inheritedTemplateOutputNames - Names of the WoofTemplateOutputModel instances that are inheriting their configuration.

contentType - Content-Type for the WoofTemplateModel.

isTemplateSecure - Indicates if the HttpTemplate requires a secure ServerHttpConnection.

linksSecure - HttpTemplate links requiring specific secure configuration.

renderRedirectHttpMethods - HTTP methods that trigger a redirect on rendering the HttpTemplate.

isContinueRendering - Indicates if allow to continue rendering.

extensionInstances - HttpTemplateExtensionInstance listing to extend the HttpTemplate.

HttpTemplateInstance

public HttpTemplateInstance(WoofTemplateModel template,
                            WoofChanges changes)

Initiate deriving details from WoofTemplateModel.

Parameters:

template - WoofTemplateModel.

changes - WoofChanges.

Method Detail

getWoofTemplateName

public String getWoofTemplateName()

Obtains the WoofTemplateModel name.

Returns:

WoofTemplateModel name.

getUri

public String getUri()

Obtains the URI.

Returns:

URI.

getTemplatePath

public String getTemplatePath()

Obtains the path to the HttpTemplate.

Returns:

Path to the HttpTemplate.

getLogicClassName

public String getLogicClassName()

Obtains the name of the logic class for the HttpTemplate.

Returns:

Name of the logic class for the HttpTemplate.

getTemplateSectionType

public SectionType getTemplateSectionType()

Obtains the SectionType.

Returns:

SectionType.

getSuperTemplate

public WoofTemplateModel getSuperTemplate()

Obtains the super WoofTemplateModel.

Returns:

Super WoofTemplateModel or null if not extending a WoofTemplateModel.

getInheritedTemplateOutputNames

public Set<String> getInheritedTemplateOutputNames()

Obtains the names of the WoofTemplateOutputModel instances that are inheriting their configuration.

Returns:

Inherited WoofTemplateOutputModel names.

getContentType

public String getContentType()

Obtains the Content-Type for the WoofTemplateModel.

Returns:

Content-Type for the WoofTemplateModel.

isTemplateSecure

public boolean isTemplateSecure()

Obtains whether the HttpTemplate requires a secure ServerHttpConnection.

Returns:

true should the HttpTemplate require a secure ServerHttpConnection.

getLinksSecure

public Map<String,Boolean> getLinksSecure()

Obtains the mapping of secure for HttpTemplate links.

Returns:

Mapping of secure for HttpTemplate links.

getRenderRedirectHttpMethods

public String[] getRenderRedirectHttpMethods()

Obtains the HTTP methods that will trigger a redirect on rendering the HttpTemplate.

Returns:

HTTP methods that will trigger a redirect on rendering the HttpTemplate.

isContinueRendering

public boolean isContinueRendering()

Indicates if may continue rendering.

Returns:

true to allow continue rendering.

getTemplateExtensionInstances

public HttpTemplateExtensionInstance[] getTemplateExtensionInstances()

Obtains the HttpTemplateExtensionInstance listing.

Returns:

HttpTemplateExtensionInstance listing.

getWoofTemplateExtensions

public WoofTemplateExtension[] getWoofTemplateExtensions()

Obtains the WoofTemplateExtension instances.

Returns:

WoofTemplateExtension instances.

getTemplateOutputNames

public String[] getTemplateOutputNames()

Obtains the WoofTemplateOutputModel names on the WoofTemplateModel being refactored.

Returns:

WoofTemplateOutputModel names on the WoofTemplateModel being refactored. May be null

getOutputNameMapping

public Map<String,String> getOutputNameMapping()

Obtains the mapping of refactored SectionOutputType name to existing WoofTemplateOutputModel name.

Returns:

Mapping of refactored SectionOutputType name to existing WoofTemplateOutputModel name. May be null.