com.exalead.cloudview.alerting.v10

Class SimpleMailPublisher

java.lang.Object

com.exalead.cloudview.alerting.v10.AlertPublisher

com.exalead.cloudview.alerting.v10.SimpleMailPublisher

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class SimpleMailPublisher
extends AlertPublisher
implements com.exalead.util.Checkable, java.io.Serializable

In the formats, the following entries are replaced:
${TOTAL_NB_RESULTS}, ${NB_ALERTS}, ${USER}, ${ALERT_NAME}, ${ALERT_DESCRIPTION},
${ALERT_NB_RESULTS}, ${TITLE}, ${TEXT}, ${ID}

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleMailPublisher.MetaToExpose

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FEED_TO_RENDER
static boolean	DEFAULT_GROUP_ALERTS_BY_USER
static java.lang.String	DEFAULT_MAIL_TEMPLATE
static java.lang.String	DEFAULT_MAIL_TEMPLATE_DIRECTORY
static java.lang.String	DEFAULT_TITLE_FORMAT
java.lang.String	feedToRender
java.lang.String	fromAddress
boolean	groupAlertsByUser
java.lang.String	mailTemplate
java.lang.String	mailTemplateDirectory
protected SimpleMailPublisher.MetaToExpose	metaToExpose
SMTPServer	sMTPServer
java.lang.String	titleFormat
java.lang.String	toAddressFormat

Fields inherited from class com.exalead.cloudview.alerting.v10.AlertPublisher

name

Constructor Summary

Constructors

Constructor and Description
SimpleMailPublisher()
SimpleMailPublisher(SimpleMailPublisher o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SimpleMailPublisher.
static SimpleMailPublisher	fromString(java.lang.String s) String representation of this SimpleMailPublisher.
java.lang.String	getFeedToRender() Name of the top-level feed to render.
java.lang.String	getFromAddress() E-mail address that will appear as "From" in alerting mails.
java.lang.String	getMailTemplate()
java.lang.String	getMailTemplateDirectory()
SimpleMailPublisher.MetaToExpose	getMetaToExpose()
SMTPServer	getSMTPServer()
java.lang.String	getTitleFormat()
java.lang.String	getToAddressFormat() Format string used to build the recipient e-mail address.
boolean	isGroupAlertsByUser()
SimpleMailPublisher	makeCopy() Creates and returns a deep copy of this SimpleMailPublisher.
static SimpleMailPublisher	readFrom(java.io.InputStream is) Read this SimpleMailPublisher from an XML fragment.
void	setFeedToRender(java.lang.String feedToRender) Name of the top-level feed to render.
void	setFromAddress(java.lang.String fromAddress) E-mail address that will appear as "From" in alerting mails.
void	setGroupAlertsByUser(boolean groupAlertsByUser)
void	setMailTemplate(java.lang.String mailTemplate)
void	setMailTemplateDirectory(java.lang.String mailTemplateDirectory)
void	setMetaToExpose(SimpleMailPublisher.MetaToExpose __value)
void	setSMTPServer(SMTPServer sMTPServer)
void	setTitleFormat(java.lang.String titleFormat)
void	setToAddressFormat(java.lang.String toAddressFormat) Format string used to build the recipient e-mail address.
java.lang.String	toString() String representation of this SimpleMailPublisher.
SimpleMailPublisher	withFeedToRender(java.lang.String feedToRender)
SimpleMailPublisher	withFromAddress(java.lang.String fromAddress)
SimpleMailPublisher	withGroupAlertsByUser(boolean groupAlertsByUser)
SimpleMailPublisher	withGroupAlertsByUser(java.lang.Boolean groupAlertsByUser)
SimpleMailPublisher	withMailTemplate(java.lang.String mailTemplate)
SimpleMailPublisher	withMailTemplateDirectory(java.lang.String mailTemplateDirectory)
SimpleMailPublisher	withMetaToExpose(java.util.Collection<StringValue> __values)
SimpleMailPublisher	withMetaToExpose(SimpleMailPublisher.MetaToExpose __value)
SimpleMailPublisher	withMetaToExpose(StringValue... __values)
SimpleMailPublisher	withName(java.lang.String name)
SimpleMailPublisher	withSMTPServer(SMTPServer sMTPServer)
SimpleMailPublisher	withTitleFormat(java.lang.String titleFormat)
SimpleMailPublisher	withToAddressFormat(java.lang.String toAddressFormat)
void	writeTo(java.io.OutputStream os) Write this SimpleMailPublisher as an XML fragment

Methods inherited from class com.exalead.cloudview.alerting.v10.AlertPublisher

getName, setName

Methods inherited from class java.lang.Object

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

Field Detail

fromAddress

public java.lang.String fromAddress

toAddressFormat

public java.lang.String toAddressFormat

titleFormat

public java.lang.String titleFormat

DEFAULT_TITLE_FORMAT

public static final java.lang.String DEFAULT_TITLE_FORMAT

See Also:

Constant Field Values

mailTemplateDirectory

public java.lang.String mailTemplateDirectory

DEFAULT_MAIL_TEMPLATE_DIRECTORY

public static final java.lang.String DEFAULT_MAIL_TEMPLATE_DIRECTORY

See Also:

Constant Field Values

mailTemplate

public java.lang.String mailTemplate

DEFAULT_MAIL_TEMPLATE

public static final java.lang.String DEFAULT_MAIL_TEMPLATE

See Also:

Constant Field Values

groupAlertsByUser

public boolean groupAlertsByUser

DEFAULT_GROUP_ALERTS_BY_USER

public static final boolean DEFAULT_GROUP_ALERTS_BY_USER

See Also:

Constant Field Values

feedToRender

public java.lang.String feedToRender

DEFAULT_FEED_TO_RENDER

public static final java.lang.String DEFAULT_FEED_TO_RENDER

See Also:

Constant Field Values

metaToExpose

protected SimpleMailPublisher.MetaToExpose metaToExpose

sMTPServer

public SMTPServer sMTPServer

Constructor Detail

SimpleMailPublisher

public SimpleMailPublisher()

SimpleMailPublisher

public SimpleMailPublisher(SimpleMailPublisher o)

Copy constructor

Method Detail

withName

public SimpleMailPublisher withName(java.lang.String name)

Overrides:

withName in class AlertPublisher

setFromAddress

public void setFromAddress(java.lang.String fromAddress)

E-mail address that will appear as "From" in alerting mails.

getFromAddress

public java.lang.String getFromAddress()

E-mail address that will appear as "From" in alerting mails.

withFromAddress

public SimpleMailPublisher withFromAddress(java.lang.String fromAddress)

setToAddressFormat

public void setToAddressFormat(java.lang.String toAddressFormat)

Format string used to build the recipient e-mail address. ${USER} is automatically substituted with the login of the user.
For example, if the format is "${USER}@mycompany.com", and "user1" sets up an alert, mails for this alert are sent to "user1@mycompany.com".

getToAddressFormat

public java.lang.String getToAddressFormat()

Format string used to build the recipient e-mail address. ${USER} is automatically substituted with the login of the user.
For example, if the format is "${USER}@mycompany.com", and "user1" sets up an alert, mails for this alert are sent to "user1@mycompany.com".

withToAddressFormat

public SimpleMailPublisher withToAddressFormat(java.lang.String toAddressFormat)

setTitleFormat

public void setTitleFormat(java.lang.String titleFormat)

getTitleFormat

public java.lang.String getTitleFormat()

withTitleFormat

public SimpleMailPublisher withTitleFormat(java.lang.String titleFormat)

setMailTemplateDirectory

public void setMailTemplateDirectory(java.lang.String mailTemplateDirectory)

getMailTemplateDirectory

public java.lang.String getMailTemplateDirectory()

withMailTemplateDirectory

public SimpleMailPublisher withMailTemplateDirectory(java.lang.String mailTemplateDirectory)

setMailTemplate

public void setMailTemplate(java.lang.String mailTemplate)

getMailTemplate

public java.lang.String getMailTemplate()

withMailTemplate

public SimpleMailPublisher withMailTemplate(java.lang.String mailTemplate)

setGroupAlertsByUser

public void setGroupAlertsByUser(boolean groupAlertsByUser)

isGroupAlertsByUser

public boolean isGroupAlertsByUser()

withGroupAlertsByUser

public SimpleMailPublisher withGroupAlertsByUser(boolean groupAlertsByUser)

withGroupAlertsByUser

public SimpleMailPublisher withGroupAlertsByUser(java.lang.Boolean groupAlertsByUser)

setFeedToRender

public void setFeedToRender(java.lang.String feedToRender)

Name of the top-level feed to render.

getFeedToRender

public java.lang.String getFeedToRender()

Name of the top-level feed to render.

withFeedToRender

public SimpleMailPublisher withFeedToRender(java.lang.String feedToRender)

getMetaToExpose

public SimpleMailPublisher.MetaToExpose getMetaToExpose()

setMetaToExpose

public void setMetaToExpose(SimpleMailPublisher.MetaToExpose __value)

withMetaToExpose

public SimpleMailPublisher withMetaToExpose(StringValue... __values)

withMetaToExpose

public SimpleMailPublisher withMetaToExpose(java.util.Collection<StringValue> __values)

withMetaToExpose

public SimpleMailPublisher withMetaToExpose(SimpleMailPublisher.MetaToExpose __value)

setSMTPServer

public void setSMTPServer(SMTPServer sMTPServer)

getSMTPServer

public SMTPServer getSMTPServer()

withSMTPServer

public SimpleMailPublisher withSMTPServer(SMTPServer sMTPServer)

makeCopy

public SimpleMailPublisher makeCopy()

Creates and returns a deep copy of this SimpleMailPublisher.

Overrides:

makeCopy in class AlertPublisher

readFrom

public static SimpleMailPublisher readFrom(java.io.InputStream is)
                                    throws javax.xml.bind.JAXBException

Read this SimpleMailPublisher from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this SimpleMailPublisher as an XML fragment

Overrides:

writeTo in class AlertPublisher

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static SimpleMailPublisher fromString(java.lang.String s)
                                      throws javax.xml.bind.JAXBException,
                                             java.io.UnsupportedEncodingException

String representation of this SimpleMailPublisher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SimpleMailPublisher.

Overrides:

toString in class AlertPublisher

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this SimpleMailPublisher.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AlertPublisher

Throws:

com.exalead.util.TypedException