Package adams.flow.standalone.rats.output

Class SendEmail

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.MultiAttemptSupporter, adams.core.MultiAttemptWithWaitSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable
    public class SendEmail
extends AbstractRatOutput
implements adams.core.MultiAttemptWithWaitSupporter
    Transmitter for sending emails.


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -send-email <adams.core.net.SendEmail> (property: sendEmail)
    The engine for sending the emails.
    default: adams.core.net.JavaMailSendEmail
 
    -num-attempts <int> (property: numAttempts)
    The maximum number of initialization attempts to undertake.
    default: 3
    minimum: 1
 
    -attempt-interval <int> (property: attemptInterval)
    The time in msec to wait before the next attempt.
    default: 1000
    minimum: 0
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_SendEmail

        protected adams.core.net.SendEmail m_SendEmail
        for sending the emails.

      • m_NumAttempts

        protected int m_NumAttempts
        the maximum number of initialization attempts.

      • m_AttemptInterval

        protected int m_AttemptInterval
        the interval between attempts.

    • Constructor Detail

      • SendEmail

        public SendEmail()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractRatOutput
        Returns:
        null if no info available, otherwise short string

      • setSendEmail

        public void setSendEmail​(adams.core.net.SendEmail value)
        Sets the object for sending emails.
        Parameters:
        value - the object

      • getSendEmail

        public adams.core.net.SendEmail getSendEmail()
        Returns the object for sending emails.
        Returns:
        the object

      • sendEmailTipText

        public String sendEmailTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumAttempts

        public void setNumAttempts​(int value)
        Sets the maximum number of initialization attempts.
        Specified by:
        setNumAttempts in interface adams.core.MultiAttemptSupporter
        Parameters:
        value - the maximum

      • getNumAttempts

        public int getNumAttempts()
        Returns the maximum number of initialization attempts.
        Specified by:
        getNumAttempts in interface adams.core.MultiAttemptSupporter
        Returns:
        the maximum

      • numAttemptsTipText

        public String numAttemptsTipText()
        Returns the tip text for this property.
        Specified by:
        numAttemptsTipText in interface adams.core.MultiAttemptSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAttemptInterval

        public void setAttemptInterval​(int value)
        Sets the time to wait between attempts in msec.
        Specified by:
        setAttemptInterval in interface adams.core.MultiAttemptWithWaitSupporter
        Parameters:
        value - the time in msec

      • getAttemptInterval

        public int getAttemptInterval()
        Returns the time to wait between attempts in msec.
        Specified by:
        getAttemptInterval in interface adams.core.MultiAttemptWithWaitSupporter
        Returns:
        the time in msec

      • attemptIntervalTipText

        public String attemptIntervalTipText()
        Returns the tip text for this property.
        Specified by:
        attemptIntervalTipText in interface adams.core.MultiAttemptWithWaitSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • check

        protected String check()
        Hook method for performing checks.
        Overrides:
        check in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message

      • initSession

        protected void initSession()
                    throws Exception
        Initializes the SMTP session if required.
        Throws:
        Exception - if initialization fails

      • doTransmit

        protected String doTransmit()
        Performs the actual transmission.
        Specified by:
        doTransmit in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message