net.officefloor.eclipse.wizard.template.HttpTemplateInstance Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of net.officefloor.woof Show documentation
Show all versions of net.officefloor.woof Show documentation
OfficeFloor WoOF Eclipse plug-in
/*
* OfficeFloor - http://www.officefloor.net
* Copyright (C) 2005-2013 Daniel Sagenschneider
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see inheritedTemplateOutputNames;
/**
* Content-Type for the {@link WoofTemplateModel}.
*/
private final String contentType;
/**
* Indicates if the {@link HttpTemplate} requires a secure
* {@link ServerHttpConnection}.
*/
private final boolean isTemplateSecure;
/**
* {@link HttpTemplate} links requiring specific secure configuration.
*/
private final Map linksSecure;
/**
* HTTP methods that trigger a redirect on rendering the
* {@link HttpTemplate}.
*/
private final String[] renderRedirectHttpMethods;
/**
* Indicates if allow to continue rendering. As continue rendering is
* typically used very seldomly (if at all) within applications this is
* false by default to avoid cluttering space in the WoOF
* configuration.
*/
private final boolean isContinueRendering;
/**
* {@link HttpTemplateExtensionInstance} listing to extend the
* {@link HttpTemplate}.
*/
private final HttpTemplateExtensionInstance[] extensionInstances;
/**
* {@link WoofTemplateOutputModel} names on the {@link WoofTemplateModel}
* being refactored.
*/
private final String[] outputNames;
/**
* Mapping of {@link SectionOutputType} name to existing
* {@link WoofTemplateOutputModel} name.
*/
private final Map ouputNameMapping;
/**
* Initiate.
*
* @param woofTemplateName
* {@link WoofTemplateModel} name.
* @param uri
* URI.
* @param templatePath
* Path to the {@link HttpTemplate}.
* @param logicClassName
* Name of the logic class.
* @param sectionType
* {@link SectionType}.
* @param superTemplate
* Super {@link WoofTemplateModel}. May be null if
* not inheriting.
* @param inheritedTemplateOutputNames
* Names of the {@link WoofTemplateOutputModel} instances that
* are inheriting their configuration.
* @param contentType
* Content-Type for the {@link WoofTemplateModel}.
* @param isTemplateSecure
* Indicates if the {@link HttpTemplate} requires a secure
* {@link ServerHttpConnection}.
* @param linksSecure
* {@link HttpTemplate} links requiring specific secure
* configuration.
* @param renderRedirectHttpMethods
* HTTP methods that trigger a redirect on rendering the
* {@link HttpTemplate}.
* @param isContinueRendering
* Indicates if allow to continue rendering.
* @param extensionInstances
* {@link HttpTemplateExtensionInstance} listing to extend the
* {@link HttpTemplate}.
*/
public HttpTemplateInstance(String woofTemplateName, String uri,
String templatePath, String logicClassName,
SectionType sectionType, WoofTemplateModel superTemplate,
Set inheritedTemplateOutputNames, String contentType,
boolean isTemplateSecure, Map linksSecure,
String[] renderRedirectHttpMethods, boolean isContinueRendering,
HttpTemplateExtensionInstance[] extensionInstances) {
this.woofTemplateName = woofTemplateName;
this.uri = uri;
this.templatePath = templatePath;
this.logicClassName = logicClassName;
this.sectionType = sectionType;
this.superTemplate = superTemplate;
this.inheritedTemplateOutputNames = inheritedTemplateOutputNames;
this.contentType = contentType;
this.isTemplateSecure = isTemplateSecure;
this.linksSecure = linksSecure;
this.renderRedirectHttpMethods = renderRedirectHttpMethods;
this.isContinueRendering = isContinueRendering;
this.extensionInstances = extensionInstances;
this.outputNames = null;
this.ouputNameMapping = null;
}
/**
* Initiate deriving details from {@link WoofTemplateModel}.
*
* @param template
* {@link WoofTemplateModel}.
* @param changes
* {@link WoofChanges}.
*/
public HttpTemplateInstance(WoofTemplateModel template, WoofChanges changes) {
this.woofTemplateName = template.getWoofTemplateName();
this.uri = template.getUri();
this.templatePath = template.getTemplatePath();
this.logicClassName = template.getTemplateClassName();
this.sectionType = null;
this.contentType = template.getTemplateContentType();
this.isTemplateSecure = template.getIsTemplateSecure();
this.isContinueRendering = template.getIsContinueRendering();
// Obtain the inheritance configuration
WoofTemplateModel superTemplate = null;
Set inheritedTemplateOutputNames = null;
String superTemplateName = template.getSuperTemplate();
if (superTemplateName != null) {
// Obtain the inheritance for the super template
Map templateInheritances = changes
.getWoofTemplateInheritances();
WoofTemplateInheritance inheritance = templateInheritances
.get(superTemplateName);
if (inheritance != null) {
// Obtain the inheritance details
superTemplate = inheritance.getSuperTemplate();
inheritedTemplateOutputNames = inheritance
.getInheritedWoofTemplateOutputNames();
}
}
this.superTemplate = superTemplate;
this.inheritedTemplateOutputNames = inheritedTemplateOutputNames;
// Load the links
this.linksSecure = new HashMap();
for (WoofTemplateLinkModel link : template.getLinks()) {
this.linksSecure.put(link.getWoofTemplateLinkName(),
link.getIsLinkSecure());
}
// Load the redirects
List redirectMethods = new LinkedList();
for (WoofTemplateRedirectModel redirect : template.getRedirects()) {
redirectMethods.add(redirect.getWoofTemplateRedirectHttpMethod());
}
this.renderRedirectHttpMethods = redirectMethods
.toArray(new String[redirectMethods.size()]);
// Obtain the extension details
List extensionInstances = new LinkedList();
for (WoofTemplateExtensionModel extensionModel : template
.getExtensions()) {
// Create the properties
PropertyList properties = OfficeFloorCompiler.newPropertyList();
for (PropertyModel property : extensionModel.getProperties()) {
properties.addProperty(property.getName()).setValue(
property.getValue());
}
// Create the extension instance
String extensionSourceClassName = extensionModel
.getExtensionClassName();
HttpTemplateExtensionInstance extensionInstance = new HttpTemplateExtensionInstance(
extensionSourceClassName, properties);
// Add the extension instance
extensionInstances.add(extensionInstance);
}
this.extensionInstances = extensionInstances
.toArray(new HttpTemplateExtensionInstance[extensionInstances
.size()]);
// Create the listing of output names
List templateOutputs = template.getOutputs();
List outputNameListing = new ArrayList(
templateOutputs.size());
for (WoofTemplateOutputModel templateOutput : templateOutputs) {
outputNameListing.add(templateOutput.getWoofTemplateOutputName());
}
this.outputNames = outputNameListing
.toArray(new String[outputNameListing.size()]);
// No output name mapping
this.ouputNameMapping = null;
}
/**
* Initiate from {@link HttpTemplateWizard}.
*
* @param woofTemplateName
* {@link WoofTemplateModel} name.
* @param uri
* URI.
* @param templatePath
* Path to the {@link HttpTemplate}.
* @param logicClassName
* Name of the logic class.
* @param sectionType
* {@link SectionType}.
* @param superTemplate
* Super {@link WoofTemplateModel}. May be null if
* not inheriting.
* @param inheritedTemplateOutputNames
* Names of the {@link WoofTemplateOutputModel} instances that
* are inheriting their configuration.
* @param contentType
* Content-Type for the {@link WoofTemplateModel}.
* @param isTemplateSecure
* Indicates if the {@link HttpTemplate} requires a secure
* {@link ServerHttpConnection}.
* @param linksSecure
* {@link HttpTemplate} links requiring specific secure
* configuration.
* @param renderRedirectHttpMethods
* HTTP methods that trigger a redirect on rendering the
* {@link HttpTemplate}.
* @param isContinueRendering
* Indicates if allow to continue rendering.
* @param extensionInstances
* {@link HttpTemplateExtensionInstance} listing to extend the
* {@link HttpTemplate}.
* @param outputNameMapping
* Mapping of {@link SectionOutputType} name to existing
* {@link WoofTemplateOutputModel} name.
*/
HttpTemplateInstance(String woofTemplateName, String uri,
String templatePath, String logicClassName,
SectionType sectionType, WoofTemplateModel superTemplate,
Set inheritedTemplateOutputNames, String contentType,
boolean isTemplateSecure, Map linksSecure,
String[] renderRedirectHttpMethods, boolean isContinueRendering,
HttpTemplateExtensionInstance[] extensionInstances,
Map outputNameMapping) {
this.woofTemplateName = woofTemplateName;
this.uri = uri;
this.templatePath = templatePath;
this.logicClassName = logicClassName;
this.sectionType = sectionType;
this.superTemplate = superTemplate;
this.inheritedTemplateOutputNames = inheritedTemplateOutputNames;
this.contentType = contentType;
this.isTemplateSecure = isTemplateSecure;
this.linksSecure = linksSecure;
this.renderRedirectHttpMethods = renderRedirectHttpMethods;
this.isContinueRendering = isContinueRendering;
this.extensionInstances = extensionInstances;
this.outputNames = null;
this.ouputNameMapping = outputNameMapping;
}
/**
* Obtains the {@link WoofTemplateModel} name.
*
* @return {@link WoofTemplateModel} name.
*/
public String getWoofTemplateName() {
return this.woofTemplateName;
}
/**
* Obtains the URI.
*
* @return URI.
*/
public String getUri() {
return this.uri;
}
/**
* Obtains the path to the {@link HttpTemplate}.
*
* @return Path to the {@link HttpTemplate}.
*/
public String getTemplatePath() {
return this.templatePath;
}
/**
* Obtains the name of the logic class for the {@link HttpTemplate}.
*
* @return Name of the logic class for the {@link HttpTemplate}.
*/
public String getLogicClassName() {
return this.logicClassName;
}
/**
* Obtains the {@link SectionType}.
*
* @return {@link SectionType}.
*/
public SectionType getTemplateSectionType() {
return this.sectionType;
}
/**
* Obtains the super {@link WoofTemplateModel}.
*
* @return Super {@link WoofTemplateModel} or null if not
* extending a {@link WoofTemplateModel}.
*/
public WoofTemplateModel getSuperTemplate() {
return this.superTemplate;
}
/**
* Obtains the names of the {@link WoofTemplateOutputModel} instances that
* are inheriting their configuration.
*
* @return Inherited {@link WoofTemplateOutputModel} names.
*/
public Set getInheritedTemplateOutputNames() {
return this.inheritedTemplateOutputNames;
}
/**
* Obtains the Content-Type for the {@link WoofTemplateModel}.
*
* @return Content-Type for the {@link WoofTemplateModel}.
*/
public String getContentType() {
return this.contentType;
}
/**
* Obtains whether the {@link HttpTemplate} requires a secure
* {@link ServerHttpConnection}.
*
* @return true should the {@link HttpTemplate} require a
* secure {@link ServerHttpConnection}.
*/
public boolean isTemplateSecure() {
return this.isTemplateSecure;
}
/**
* Obtains the mapping of secure for {@link HttpTemplate} links.
*
* @return Mapping of secure for {@link HttpTemplate} links.
*/
public Map getLinksSecure() {
return this.linksSecure;
}
/**
* Obtains the HTTP methods that will trigger a redirect on rendering the
* {@link HttpTemplate}.
*
* @return HTTP methods that will trigger a redirect on rendering the
* {@link HttpTemplate}.
*/
public String[] getRenderRedirectHttpMethods() {
return this.renderRedirectHttpMethods;
}
/**
* Indicates if may continue rendering.
*
* @return true to allow continue rendering.
*/
public boolean isContinueRendering() {
return this.isContinueRendering;
}
/**
* Obtains the {@link HttpTemplateExtensionInstance} listing.
*
* @return {@link HttpTemplateExtensionInstance} listing.
*/
public HttpTemplateExtensionInstance[] getTemplateExtensionInstances() {
return this.extensionInstances;
}
/**
* Obtains the {@link WoofTemplateExtension} instances.
*
* @return {@link WoofTemplateExtension} instances.
*/
public WoofTemplateExtension[] getWoofTemplateExtensions() {
// Create the extensions
List extensions = new LinkedList();
for (HttpTemplateExtensionInstance extensionInstance : this
.getTemplateExtensionInstances()) {
// Obtain the properties
List properties = new LinkedList();
for (Property property : extensionInstance.getProperties()) {
properties.add(new WoofTemplateExtensionPropertyImpl(property
.getName(), property.getValue()));
}
// Create the woof template extension
String extensionSourceClassName = extensionInstance
.getTemplateExtensionClassName();
WoofTemplateExtension extension = new WoofTemplateExtensionImpl(
extensionSourceClassName,
properties
.toArray(new WoofTemplateExtensionProperty[properties
.size()]));
// Add the woof template extension
extensions.add(extension);
}
// Return the woof template extensions
return extensions.toArray(new WoofTemplateExtension[extensions.size()]);
}
/**
* Obtains the {@link WoofTemplateOutputModel} names on the
* {@link WoofTemplateModel} being refactored.
*
* @return {@link WoofTemplateOutputModel} names on the
* {@link WoofTemplateModel} being refactored. May be
* null
*/
public String[] getTemplateOutputNames() {
return this.outputNames;
}
/**
* Obtains the mapping of refactored {@link SectionOutputType} name to
* existing {@link WoofTemplateOutputModel} name.
*
* @return Mapping of refactored {@link SectionOutputType} name to existing
* {@link WoofTemplateOutputModel} name. May be null.
*/
public Map getOutputNameMapping() {
return this.ouputNameMapping;
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy