com.ergotech.vib.manipulators

Class Emailer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.manipulators.Emailer

public class Emailer
extends SimpleManipulator

This will send an email whenever it receives a value. This bean uses the JavaMail API.

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
Emailer() Generic constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDateFormatter() This is the date formatter used (by java.text.SimpleDataFormatter) to display the date (if setDate is true).
java.lang.String	getFrom() Gets the address to send we sent from.
java.lang.String	getHost() This is the SMTP Host name.
java.lang.String	getMessage() This is a string thats added to each email message.
java.lang.String	getPassword()
int	getPort() Returns the SMTP port;
boolean	getSendDate() This is if we should send the date.
boolean	getSendProperties() This is if we should send the values properties.
boolean	getSendTag() This is if we should send the tag name.
boolean	getSendValue() This is if we should send the values.
int	getStaticLocationFor(java.lang.String name) This is used for StaticMethodListener interface.
java.lang.String	getSubject() This is the subject line to send.
java.lang.String	getTo() This is the address to send to.
java.lang.String	getUserName()
boolean	isEnabled()
boolean	isMailAsAttachment()
boolean	isStarttls()
void	messageString(java.lang.String msg) Logs informational/debug messages.
void	setDateFormatter(java.lang.String newValue) This is the date formatter used (by java.text.SimpleDataFormatter) to display the date (if setDate is true).
void	setEnabled(boolean enabled)
void	setFrom(java.lang.String newValue) This is the address to send we sent from.
void	setHost(java.lang.String newValue) This is the SMTP Host name.
void	setMailAsAttachment(boolean mailAsAttachment)
void	setMessage(java.lang.String newValue) This is a string thats added to each email message.
void	setPassword(java.lang.String password)
void	setPort(int port) Sets the port for the SMTP server.
void	setSendDate(boolean newValue) This is if we should send the date.
void	setSendProperties(boolean newValue) This is if we should send the values properties.
void	setSendTag(boolean newValue) This is if we should send the tag name.
void	setSendValue(boolean newValue) This is if we should send the values.
void	setStarttls(boolean starttls)
void	setSubject(java.lang.String newValue) This is the subject line to send.
void	setTo(java.lang.String newValue) This is the address to send to.
void	setUserName(java.lang.String userName)
void	valueChanged(int loc, ValueChangedEvent e) This is used for StaticMethodListener interface.
void	valueInput(ValueChangedEvent e) This is where all events come in.

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, start, stop, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

Emailer

public Emailer()

Generic constructor.

Method Detail

getDateFormatter

public java.lang.String getDateFormatter()

This is the date formatter used (by java.text.SimpleDataFormatter) to display the date (if setDate is true).

See Also:

setDateFormatter, setSendDate

getFrom

public java.lang.String getFrom()

Gets the address to send we sent from.

See Also:

setFrom

getHost

public java.lang.String getHost()

This is the SMTP Host name. Get this from your ISP or System Administrator.

See Also:

setHost

getMessage

public java.lang.String getMessage()

This is a string thats added to each email message.

See Also:

setMessage

getPassword

public java.lang.String getPassword()

Returns:

the password

getPort

public int getPort()

Returns the SMTP port;

Returns:

the port

getSendDate

public boolean getSendDate()

This is if we should send the date.

See Also:

setSendDate

getSendProperties

public boolean getSendProperties()

This is if we should send the values properties.

See Also:

getSendProperties

getSendTag

public boolean getSendTag()

This is if we should send the tag name.

See Also:

setSendTag

getSendValue

public boolean getSendValue()

This is if we should send the values.

See Also:

setSendProperties

getStaticLocationFor

public int getStaticLocationFor(java.lang.String name)
                         throws BadParameterException

This is used for StaticMethodListener interface.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

getSubject

public java.lang.String getSubject()

This is the subject line to send.

See Also:

setSubject

getTo

public java.lang.String getTo()

This is the address to send to.

See Also:

setTo

getUserName

public java.lang.String getUserName()

Returns:

the userName

isEnabled

public boolean isEnabled()

Returns:

the enabled

isMailAsAttachment

public boolean isMailAsAttachment()

Returns:

the mailAsAttachment

isStarttls

public boolean isStarttls()

Returns:

the starttls

messageString

public void messageString(java.lang.String msg)

Logs informational/debug messages. This will also be captured as the output for the messageString output.

setDateFormatter

public void setDateFormatter(java.lang.String newValue)

This is the date formatter used (by java.text.SimpleDataFormatter) to display the date (if setDate is true).

See Also:

getDateFormatter, setSendDate

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - the enabled to set

setFrom

public void setFrom(java.lang.String newValue)

This is the address to send we sent from.

See Also:

getFrom

setHost

public void setHost(java.lang.String newValue)

This is the SMTP Host name. For example, "mail.domain.com", where domain is your mail server domain. Get this from your ISP or system administrator.

See Also:

getHost

setMailAsAttachment

public void setMailAsAttachment(boolean mailAsAttachment)

Parameters:

mailAsAttachment - the mailAsAttachment to set

setMessage

public void setMessage(java.lang.String newValue)

This is a string thats added to each email message.

See Also:

getMessage

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - the password to set

setPort

public void setPort(int port)

Sets the port for the SMTP server. The default is 25;

Parameters:

port - the SMTP port

setSendDate

public void setSendDate(boolean newValue)

This is if we should send the date.

See Also:

getSendDate

setSendProperties

public void setSendProperties(boolean newValue)

This is if we should send the values properties.

See Also:

getSendProperties

setSendTag

public void setSendTag(boolean newValue)

This is if we should send the tag name.

See Also:

getSendTag

setSendValue

public void setSendValue(boolean newValue)

This is if we should send the values.

See Also:

getSendProperties

setStarttls

public void setStarttls(boolean starttls)

Parameters:

starttls - the starttls to set

setSubject

public void setSubject(java.lang.String newValue)

This is the subject line to send.

See Also:

getSubject

setTo

public void setTo(java.lang.String newValue)

This is the address to send to. This can be a comma delimeted list of email addresses

See Also:

getTo

setUserName

public void setUserName(java.lang.String userName)

Parameters:

userName - the userName to set

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This is used for StaticMethodListener interface.

Overrides:

valueChanged in class Manipulator

Throws:

VIBUpdateFailedException

BadParameterException

valueInput

public void valueInput(ValueChangedEvent e)
                throws VIBUpdateFailedException

This is where all events come in. We will makes sure that they have a valid quality, then check shouldWeEmail(e) method.. This will then call sendMessage.

Overrides:

valueInput in class Manipulator

Parameters:

e - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException

See Also:

sendMessage, shouldWeEmail