com.crossingchannels.portal.websphere.template

Class BaseFreemarkerTemplateParser

java.lang.Object

com.crossingchannels.portal.websphere.template.BaseFreemarkerTemplateParser

All Implemented Interfaces:

TemplateParser

Direct Known Subclasses:

FreemarkerTemplateOnClasspathParser, FreemarkerTemplateOnFilesystemParser

public class BaseFreemarkerTemplateParser
extends java.lang.Object
implements TemplateParser

Base implementation of a freemarker template parser. This object is thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VAR_DEPLOYED_CI Define constant with name of deployed CI which can be used with the freemarker template.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseFreemarkerTemplateParser()
protected	BaseFreemarkerTemplateParser(freemarker.template.Configuration freemarkerConfiguration) Initialize new base freemarker template parser.

Method Summary

Methods

Modifier and Type	Method and Description
void	parse(java.lang.String templateName, com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> deployedCi, java.util.Map<java.lang.String,?> context, java.io.OutputStream out) Parse the template identified by the templateName using deployed CI and the parameters provided by the context.
void	parse(java.lang.String templateName, java.util.Map<java.lang.String,?> context, java.io.OutputStream out) Parse the template identified by the templateName using the parameters provided by the context.

Methods inherited from class java.lang.Object

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

Field Detail

VAR_DEPLOYED_CI

public static final java.lang.String VAR_DEPLOYED_CI

Define constant with name of deployed CI which can be used with the freemarker template.

See Also:

Constant Field Values

Constructor Detail

BaseFreemarkerTemplateParser

protected BaseFreemarkerTemplateParser(freemarker.template.Configuration freemarkerConfiguration)

Initialize new base freemarker template parser.

Parameters:

freemarkerConfiguration - The configuration used to locate and parse templates.

BaseFreemarkerTemplateParser

protected BaseFreemarkerTemplateParser()

Method Detail

parse

public void parse(java.lang.String templateName,
         java.util.Map<java.lang.String,?> context,
         java.io.OutputStream out)
           throws TemplateParseException

Parse the template identified by the templateName using the parameters provided by the context. The output is send to the outputstream out.

Specified by:

parse in interface TemplateParser

Parameters:

templateName - Name of the template to parse.

context - The context with parameters/variables using during parsing.

out - The output stream that will contain the parsed template.

Throws:

TemplateParseException - Thrown if an error occurs while parsing the template.

parse

public void parse(java.lang.String templateName,
         com.xebialabs.deployit.plugin.api.udm.Deployed<?,?> deployedCi,
         java.util.Map<java.lang.String,?> context,
         java.io.OutputStream out)
           throws TemplateParseException

Parse the template identified by the templateName using deployed CI and the parameters provided by the context. The output is send to the outputstream out .

Specified by:

parse in interface TemplateParser

Parameters:

templateName - Name of the template to parse.

deployedCi - The deployed CI used during parsing.

context - The context with parameters/variables using during parsing.

out - The output stream that will contain the parsed template.

Throws:

TemplateParseException - Thrown if an error occurs while parsing the template.