Package org.exoplatform.commons.notification.template

Class TemplateUtils

java.lang.Object

org.exoplatform.commons.notification.template.TemplateUtils

public class TemplateUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
TemplateUtils()

Method Summary

Modifier and Type	Method	Description
static String	cleanHtmlTags(String str)	Clean all HTML tags on string
static String	getExcerptSubject(String subject)	Get the excerpt subject of notification mail from origin string - Just contains plain text - Limit number of characters
static org.exoplatform.commons.api.notification.plugin.config.PluginConfig	getPluginConfig(String pluginId)	Gets Plugin configuration for specified PluginId
static String	getResourceBundle(String key, Locale locale, String resourcePath)	Gets Resource Bundle value
static InputStream	getTemplateInputStream(String templatePath)	Gets InputStream for groovy template
static org.exoplatform.commons.api.notification.template.Element	loadGroovyElement(String pluginId, String language)	Load the Groovy template element.
static String	loadGroovyTemplate(String templatePath)	Loads the Groovy template file
static String	processDigest(org.exoplatform.commons.api.notification.service.template.TemplateContext ctx)	Render for digest template
static String	processGroovy(org.exoplatform.commons.api.notification.service.template.TemplateContext ctx)	Process the Groovy template associate with Template context to generate It will be use for digest mail
static String	processSubject(org.exoplatform.commons.api.notification.service.template.TemplateContext ctx)	Render for Subject template

Methods inherited from class java.lang.Object

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

Constructor Details

TemplateUtils

public TemplateUtils()

Method Details

processGroovy

public static String processGroovy(org.exoplatform.commons.api.notification.service.template.TemplateContext ctx)

Process the Groovy template associate with Template context to generate It will be use for digest mail

Parameters:

ctx -

Returns:

processSubject

public static String processSubject(org.exoplatform.commons.api.notification.service.template.TemplateContext ctx)

Render for Subject template

Parameters:

ctx -

Returns:

processDigest

public static String processDigest(org.exoplatform.commons.api.notification.service.template.TemplateContext ctx)

Render for digest template

Parameters:

ctx -

Returns:

loadGroovyTemplate

public static String loadGroovyTemplate(String templatePath)

Loads the Groovy template file

Parameters:

templatePath -

Returns:

Groovy Template File content

loadGroovyElement

public static org.exoplatform.commons.api.notification.template.Element loadGroovyElement(String pluginId,
 String language)

Load the Groovy template element.

Parameters:

pluginId - The plugin's id

language - The language's id.

Returns:

The Groovy element

getExcerptSubject

public static String getExcerptSubject(String subject)

Get the excerpt subject of notification mail from origin string - Just contains plain text - Limit number of characters

Parameters:

subject - the origin string

Returns:

the excerpt of subject

Since:

4.1.x

cleanHtmlTags

public static String cleanHtmlTags(String str)

Clean all HTML tags on string

Parameters:

str - the origin string

Returns:

The string has not contain HTML tags.

Since:

4.1.x

getPluginConfig

public static org.exoplatform.commons.api.notification.plugin.config.PluginConfig getPluginConfig(String pluginId)

Gets Plugin configuration for specified PluginId

Parameters:

pluginId -

Returns:

getResourceBundle

public static String getResourceBundle(String key,
 Locale locale,
 String resourcePath)

Gets Resource Bundle value

Parameters:

key -

locale -

resourcePath -

Returns:

getTemplateInputStream

public static InputStream getTemplateInputStream(String templatePath)

Gets InputStream for groovy template

Parameters:

templatePath -

Returns:

InputStream corresponding to relative or absolute template path