Package net.solarnetwork.central.mail.support

Class ClasspathResourceMessageTemplateDataSource

java.lang.Object

net.solarnetwork.central.mail.support.SimpleMessageDataSource

net.solarnetwork.central.mail.support.ClasspathResourceMessageTemplateDataSource

All Implemented Interfaces:

MessageDataSource, MessageTemplateDataSource

public class ClasspathResourceMessageTemplateDataSource
extends SimpleMessageDataSource
implements MessageTemplateDataSource

MessageTemplateDataSource based on a locale-specific classpath resource.

The getMessageTemplate() will load a classpath resource located at the resource path passed to the class constructor. The resource path must have a file extension, and first this method will insert _lang before the file extension and attempt to use that resource, where lang is the language value returned by Locale.getLanguage() on the Locale object passed to the class constructor.

If the language-specific resource is not found, it will try to use the resource path exactly as configured. If that resource cannot be found, a RuntimeException will be thrown.

Field Summary

Fields inherited from interface net.solarnetwork.central.mail.MessageTemplateDataSource

STANDARD_WORD_WRAP_COLUMN

Constructor Summary

Constructors

Constructor	Description
ClasspathResourceMessageTemplateDataSource(Locale locale, String subject, String resource, Map<String,?> model)	Construct with values.

Method Summary

Modifier and Type	Method	Description
String	getBody()	Get the message body.
ClassLoader	getClassLoader()	Get the custom ClassLoader to use when resolving the template resource.
Locale	getLocale()	Get a Locale for the message.
org.springframework.core.io.Resource	getMessageTemplate()	Get the message template.
Map<String,?>	getModel()	Get a message template model to merge into the message.
Integer	getWordWrapCharacterIndex()	Get a character column index at which to hard-wrap message text at.
void	setClassLoader(ClassLoader classLoader)	Set a custom ClassLoader to use when resolving the template resource.
void	setWordWrapCharacterIndex(Integer wordWrapCharacterIndex)	Set the word wrap character index.

Methods inherited from class net.solarnetwork.central.mail.support.SimpleMessageDataSource

getAttachments, getSubject, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.central.mail.MessageDataSource

getAttachments

Methods inherited from interface net.solarnetwork.central.mail.MessageTemplateDataSource

getSubject

Constructor Details

ClasspathResourceMessageTemplateDataSource

public ClasspathResourceMessageTemplateDataSource(Locale locale,
 String subject,
 String resource,
 Map<String,?> model)

Construct with values.

Parameters:

locale - the locale to use when locating the message resource

subject - the subject to use

resource - the resource path to the message template

model - the mail merge model to use

Method Details

getLocale

public Locale getLocale()

Description copied from interface: MessageTemplateDataSource

Get a Locale for the message.

Specified by:

getLocale in interface MessageTemplateDataSource

Returns:

a Locale

getMessageTemplate

public org.springframework.core.io.Resource getMessageTemplate()

Description copied from interface: MessageTemplateDataSource

Get the message template.

Specified by:

getMessageTemplate in interface MessageTemplateDataSource

Returns:

message template

getModel

public Map<String,?> getModel()

Description copied from interface: MessageTemplateDataSource

Get a message template model to merge into the message.

Specified by:

getModel in interface MessageTemplateDataSource

Returns:

Map of model objects

getBody

public String getBody()

Description copied from interface: MessageDataSource

Get the message body.

Specified by:

getBody in interface MessageDataSource

Overrides:

getBody in class SimpleMessageDataSource

Returns:

the message body, or null if none

getClassLoader

public ClassLoader getClassLoader()

Get the custom ClassLoader to use when resolving the template resource.

Returns:

classLoader The ClassLoader to use.

Since:

1.1

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Set a custom ClassLoader to use when resolving the template resource.

Parameters:

classLoader - The ClassLoader to use.

Since:

1.1

getWordWrapCharacterIndex

public Integer getWordWrapCharacterIndex()

Description copied from interface: MessageTemplateDataSource

Get a character column index at which to hard-wrap message text at. Return 0 to indicate no wrapping should occur.

Specified by:

getWordWrapCharacterIndex in interface MessageTemplateDataSource

Returns:

The word wrap character column index, or null if unspecified.

setWordWrapCharacterIndex

public void setWordWrapCharacterIndex(Integer wordWrapCharacterIndex)

Set the word wrap character index.

Parameters:

wordWrapCharacterIndex - The word wrap character index to set.

Since:

1.1

See Also:

• MessageTemplateDataSource.getWordWrapCharacterIndex()