Package com.atlassian.bamboo.ww2

Class BambooFreemarkerManager

java.lang.Object

org.apache.struts2.views.freemarker.FreemarkerManager

com.atlassian.bamboo.ww2.BambooFreemarkerManager

All Implemented Interfaces:

TemplateRenderer, org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

@Internal
public class BambooFreemarkerManager
extends org.apache.struts2.views.freemarker.FreemarkerManager
implements TemplateRenderer, org.springframework.web.context.ServletContextAware

FreemarkerManager that automatically detects the alternative syntax

Field Summary

Fields

Modifier and Type	Field	Description
static final freemarker.template.Version	FREEMARKER_COMPATIBILITY_VERSION
static final String	PARAM_BAMBOO_PERMISSION_MANAGER
static final String	PARAM_BASE_URL
static final String	PARAM_BUILD_UTILS
static final String	PARAM_CONTEXT
static final String	PARAM_I18N_BEAN
static final String	PARAM_JIRA_ISSUE_UTILS
static final String	PARAM_STATIC_RESOURCE_PREFIX
static final String	PARAM_WEB_RESOURCE_MANAGER

Fields inherited from class org.apache.struts2.views.freemarker.FreemarkerManager

altMapWrapper, ATTR_TEMPLATE_MODEL, cacheBeanWrapper, config, CONFIG_SERVLET_CONTEXT_KEY, contentType, debug, DEFAULT_CONTENT_TYPE, encoding, EXPIRATION_DATE, INITPARAM_CONTENT_TYPE, INITPARAM_DEBUG, INITPARAM_NOCACHE, INITPARAM_TEMPLATE_PATH, KEY_APPLICATION, KEY_APPLICATION_PRIVATE, KEY_EXCEPTION, KEY_JSP_TAGLIBS, KEY_REQUEST, KEY_REQUEST_PARAMETERS_STRUTS, KEY_SESSION, mruMaxStrongSize, nocache, noCharsetInContentType, tagLibraries, templatePath, templateUpdateDelay, wrapper

Constructor Summary

Constructors

Constructor	Description
BambooFreemarkerManager()

Method Summary

Modifier and Type	Method	Description
org.apache.struts2.views.freemarker.ScopesHashModel	buildTemplateModel(org.apache.struts2.util.ValueStack stack, @Nullable Object action, jakarta.servlet.ServletContext servletContext, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, freemarker.template.ObjectWrapper wrapper)
void	clearCaches()
protected freemarker.template.Configuration	createConfiguration(jakarta.servlet.ServletContext servletContext)
protected freemarker.template.ObjectWrapper	createObjectWrapper(jakarta.servlet.ServletContext servletContext)	Temporarily overriding the object wrapper
protected freemarker.cache.TemplateLoader	createTemplateLoader(jakarta.servlet.ServletContext servletContext, String ignore)
protected freemarker.template.Version	getFreemarkerVersion(jakarta.servlet.ServletContext servletContext)
void	init(jakarta.servlet.ServletContext servletContext)
void	populateContext(org.apache.struts2.views.freemarker.ScopesHashModel model, org.apache.struts2.util.ValueStack stack, Object action, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
@Nullable String	render(@Nullable String templatePath, @Nullable Map<String,Object> contextParams)
void	render(String templatePath, @Nullable Map<String,Object> contextParams, @NotNull Writer writer)	Render the given template to the given writer
@NotNull String	renderPage(@NotNull String templatePath, Map<String,Object> params)	Render the resource found at the path
@NotNull String	renderText(@Nullable String text, Map<String,Object> params)	Render Freemarker markup.
@NotNull String	renderTextWithoutActionContext(@NotNull String text, Map<String,Object> params)
@NotNull String	renderWithoutActionContext(@Nullable String templatePath, @NotNull Map<String,Object> contextParams)	Renders the resource found at the path.
void	setEncoding(String encoding)
void	setHomeLocator(@Nullable BambooHomeLocator homeLocator)
void	setI18nBeanFactory(@Nullable I18nBeanFactory i18nBeanFactory)
void	setOsgiServiceProxyFactory(OsgiServiceProxyFactory osgiServiceProxyFactory)
void	setPluginAccessor(@Nullable com.atlassian.plugin.PluginAccessor pluginAccessor)
void	setServletContext(jakarta.servlet.ServletContext servletContext)

Methods inherited from class org.apache.struts2.views.freemarker.FreemarkerManager

addSetting, buildScopesHashModel, configureTemplateLoader, getConfig, getConfiguration, getContentType, getDebug, getNocache, getNoCharsetInContentType, getTemplatePath, getWrapper, loadSettings, setCacheBeanWrapper, setContainer, setFileManagerFactory, setMruMaxStrongSize, setTemplateUpdateDelay, setThemeTemplateLoader, setWrapperAltMap

Methods inherited from class java.lang.Object

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

Field Details

PARAM_BASE_URL

public static final String PARAM_BASE_URL

See Also:

• Constant Field Values

PARAM_CONTEXT

public static final String PARAM_CONTEXT

See Also:

• Constant Field Values

PARAM_I18N_BEAN

public static final String PARAM_I18N_BEAN

See Also:

• Constant Field Values

PARAM_JIRA_ISSUE_UTILS

public static final String PARAM_JIRA_ISSUE_UTILS

See Also:

• Constant Field Values

PARAM_WEB_RESOURCE_MANAGER

public static final String PARAM_WEB_RESOURCE_MANAGER

See Also:

• Constant Field Values

PARAM_STATIC_RESOURCE_PREFIX

public static final String PARAM_STATIC_RESOURCE_PREFIX

See Also:

• Constant Field Values

PARAM_BAMBOO_PERMISSION_MANAGER

public static final String PARAM_BAMBOO_PERMISSION_MANAGER

See Also:

• Constant Field Values

PARAM_BUILD_UTILS

public static final String PARAM_BUILD_UTILS

See Also:

• Constant Field Values

FREEMARKER_COMPATIBILITY_VERSION

public static final freemarker.template.Version FREEMARKER_COMPATIBILITY_VERSION

Constructor Details

BambooFreemarkerManager

public BambooFreemarkerManager()

Method Details

createObjectWrapper

protected freemarker.template.ObjectWrapper createObjectWrapper(jakarta.servlet.ServletContext servletContext)

Temporarily overriding the object wrapper

Overrides:

createObjectWrapper in class org.apache.struts2.views.freemarker.FreemarkerManager

init

public void init(jakarta.servlet.ServletContext servletContext)
          throws freemarker.template.TemplateException

Overrides:

init in class org.apache.struts2.views.freemarker.FreemarkerManager

Throws:

freemarker.template.TemplateException

getFreemarkerVersion

protected freemarker.template.Version getFreemarkerVersion(jakarta.servlet.ServletContext servletContext)

Overrides:

getFreemarkerVersion in class org.apache.struts2.views.freemarker.FreemarkerManager

setEncoding

public void setEncoding(String encoding)

Overrides:

setEncoding in class org.apache.struts2.views.freemarker.FreemarkerManager

createConfiguration

protected freemarker.template.Configuration createConfiguration(jakarta.servlet.ServletContext servletContext)
                                                         throws freemarker.template.TemplateException

Overrides:

createConfiguration in class org.apache.struts2.views.freemarker.FreemarkerManager

Throws:

freemarker.template.TemplateException

createTemplateLoader

protected freemarker.cache.TemplateLoader createTemplateLoader(jakarta.servlet.ServletContext servletContext,
 String ignore)

Overrides:

createTemplateLoader in class org.apache.struts2.views.freemarker.FreemarkerManager

populateContext

public void populateContext(org.apache.struts2.views.freemarker.ScopesHashModel model,
 org.apache.struts2.util.ValueStack stack,
 Object action,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Overrides:

populateContext in class org.apache.struts2.views.freemarker.FreemarkerManager

render

@Nullable
public @Nullable String render(@Nullable
 @Nullable String templatePath,
 @Nullable
 @Nullable Map<String,Object> contextParams)

Specified by:

render in interface TemplateRenderer

renderPage

@NotNull
public @NotNull String renderPage(@NotNull
 @NotNull String templatePath,
 Map<String,Object> params)

Render the resource found at the path

Parameters:

templatePath - must not be null

params - params to pass to the Freemarker context. May be null

Returns:

the rendered result of the page

renderWithoutActionContext

@NotNull
public @NotNull String renderWithoutActionContext(@Nullable
 @Nullable String templatePath,
 @NotNull
 @NotNull Map<String,Object> contextParams)

Renders the resource found at the path. Does not access variables found in webwork action context.

Specified by:

renderWithoutActionContext in interface TemplateRenderer

Parameters:

templatePath - must not be null

contextParams - params to pass to the Freemarker context. May be null

Returns:

the rendered result of the page

render

public void render(String templatePath,
 @Nullable
 @Nullable Map<String,Object> contextParams,
 @NotNull
 @NotNull Writer writer)
            throws IOException

Render the given template to the given writer

Specified by:

render in interface TemplateRenderer

Parameters:

templatePath - The path of the template

contextParams - The template context params

writer - The writer to write to

Throws:

IOException - If an error occurred while writing to the writer

renderTextWithoutActionContext

@NotNull
public @NotNull String renderTextWithoutActionContext(@NotNull
 @NotNull String text,
 Map<String,Object> params)

Specified by:

renderTextWithoutActionContext in interface TemplateRenderer

renderText

@NotNull
public @NotNull String renderText(@Nullable
 @Nullable String text,
 Map<String,Object> params)

Render Freemarker markup. In order to correctly handle @ww.action tags which would write to the writer obtained from HttpServletResponse it is required to setup a wrapper to the response object and provide own writer there.

Specified by:

renderText in interface TemplateRenderer

Parameters:

text - String containing Freemarker markup

params - parameters

Returns:

Rendered Freemarker template

clearCaches

public void clearCaches()

setHomeLocator

public void setHomeLocator(@Nullable
 @Nullable BambooHomeLocator homeLocator)

setPluginAccessor

public void setPluginAccessor(@Nullable
 @Nullable com.atlassian.plugin.PluginAccessor pluginAccessor)

setI18nBeanFactory

public void setI18nBeanFactory(@Nullable
 @Nullable I18nBeanFactory i18nBeanFactory)

setServletContext

public void setServletContext(jakarta.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

setOsgiServiceProxyFactory

public void setOsgiServiceProxyFactory(OsgiServiceProxyFactory osgiServiceProxyFactory)

buildTemplateModel

public org.apache.struts2.views.freemarker.ScopesHashModel buildTemplateModel(org.apache.struts2.util.ValueStack stack,
 @Nullable
 @Nullable Object action,
 jakarta.servlet.ServletContext servletContext,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 freemarker.template.ObjectWrapper wrapper)

Overrides:

buildTemplateModel in class org.apache.struts2.views.freemarker.FreemarkerManager