com.atlassian.confluence.mail
Class VelocityRenderedQueueItem

java.lang.Object
  com.atlassian.confluence.mail.VelocityRenderedQueueItem

All Implemented Interfaces:

Task, Serializable

Direct Known Subclasses:

AbstractMailNotificationQueueItem

public abstract class VelocityRenderedQueueItem
extends Object
implements Task

See Also:

Serialized Form

Field Summary

protected String

body

Constructor Summary

protected	VelocityRenderedQueueItem(String templateContent)
protected	VelocityRenderedQueueItem(String templateLocation, String templateFileName)

Method Summary

void	addVelocityContextParam(String name, Object value)
void	clearContext()
String	getBody()
String	getRenderedContent()
String	getRenderedContent(String content)
String	getTemplateContent()
String	getTemplateFileName()
String	getTemplateLocation()
Object	getVelocityContextParam(String name)
void	preRenderBody(Map contextMap) This method will not retain a local copy of the contextMap - making it advantageous for pre-rendering templates with contexts comprising of transient or session-based data.
Object	removeVelocityContextParam(String name)
void	setBody(String body)
void	setTemplateContent(String templateContent)
void	setTemplateFileName(String templateFileName)
void	setTemplateLocation(String templateLocation)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.core.task.Task

execute

Field Detail

body

protected String body

Constructor Detail

VelocityRenderedQueueItem

protected VelocityRenderedQueueItem(String templateLocation,
                                    String templateFileName)

VelocityRenderedQueueItem

protected VelocityRenderedQueueItem(String templateContent)

Method Detail

addVelocityContextParam

public void addVelocityContextParam(String name,
                                    Object value)

removeVelocityContextParam

public Object removeVelocityContextParam(String name)

clearContext

public void clearContext()

getVelocityContextParam

public Object getVelocityContextParam(String name)

preRenderBody

public void preRenderBody(Map contextMap)

This method will not retain a local copy of the contextMap - making it advantageous for pre-rendering templates with contexts comprising of transient or session-based data.

Parameters:

contextMap -

getRenderedContent

public String getRenderedContent(String content)

getRenderedContent

public String getRenderedContent()

getTemplateFileName

public String getTemplateFileName()

setTemplateFileName

public void setTemplateFileName(String templateFileName)

getTemplateContent

public String getTemplateContent()

setTemplateContent

public void setTemplateContent(String templateContent)

getTemplateLocation

public String getTemplateLocation()

setTemplateLocation

public void setTemplateLocation(String templateLocation)

getBody

public String getBody()

setBody

public void setBody(String body)