Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.activity.delivery
Class DeliverToSMTPActivity

java.lang.Object
  |
  +--uk.org.ogsadai.activity.Activity
        |
        +--uk.org.ogsadai.activity.delivery.DeliverToSMTPActivity
public class DeliverToSMTPActivity
extends Activity

An activity to consume input data and delivers it by email using the Standard Mail Transfer Protocol (SMTP). See the activity user documentation for more details: OGSADAI/doc/interaction/activities/delivery/deliverToFile.html

Author:
The OGSA-DAI Project Team

Field Summary
private static java.lang.String COPYRIGHT_NOTICE
          Copyright statement
private static DAILogger LOG
          Logger object for logging in this class
private  java.lang.String mFromAddress
          E-mail from address
private  BlockReader mInput
          Activity input - output from another activity
private  java.io.BufferedReader mInputStream
           
private  java.io.DataOutputStream mOutputStream
           
private  java.lang.String mServer
          SMTP server
private  java.lang.String mSubject
          E-mail subject line
private  java.util.List mToAddresses
          Address list - list of strings
 
Fields inherited from class uk.org.ogsadai.activity.Activity
mContext, mExternalInputs, mExternalOutputs, mInternalInputs, mInternalOutputs
 
Constructor Summary
DeliverToSMTPActivity(org.w3c.dom.Element element)
           
 
Method Summary
 void initialise()
          This method should be overridden by subclasses to perform any initialisation they require before the process method invocations begin.
private  java.lang.String listToCommaSeparatedString(java.util.List list)
          Convert a list of strings into a comma-separated list.
 void processBlock()
          Performs an iteration of the processing of an activity.
 void processFirst()
          This method is called during the first iteration of processing an activity.
 
Methods inherited from class uk.org.ogsadai.activity.Activity
cleanUp, connectsTo, createOutputPipe, getActivityConfiguration, getActivityName, getCause, getName, getObservableStatus, getProperties, getSession, getStatus, hasActivityConfiguration, hasProperties, process, setActivityName, setCompleted, setError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE
Copyright statement

See Also:
Constant Field Values

LOG

private static DAILogger LOG
Logger object for logging in this class

mServer

private java.lang.String mServer
SMTP server

mToAddresses

private java.util.List mToAddresses
Address list - list of strings

mSubject

private java.lang.String mSubject
E-mail subject line

mFromAddress

private java.lang.String mFromAddress
E-mail from address

mInput

private BlockReader mInput
Activity input - output from another activity

mInputStream

private java.io.BufferedReader mInputStream

mOutputStream

private java.io.DataOutputStream mOutputStream
Constructor Detail

DeliverToSMTPActivity

public DeliverToSMTPActivity(org.w3c.dom.Element element)
                      throws ActivityCreationException,
                             ActivitySpecificationException
Method Detail

initialise

public void initialise()
                throws ActivitySpecificationException,
                       ActivityExecutionException
Description copied from class: Activity
This method should be overridden by subclasses to perform any initialisation they require before the process method invocations begin. This might be used for setting up convenient fields to reference objects contained in the context. It shouldn't be used for opening resources. That should be done in processFirst.

Overrides:
initialise in class Activity
Throws:
ActivityExecutionException - If some system problem prevents the activity from initialising.
ActivitySpecificationException - If a problem with settings provided by a client prevents the activity from initialising.

processFirst

public void processFirst()
Description copied from class: Activity
This method is called during the first iteration of processing an activity. It can be overridden by subclasses to define some processing that should be done only once during the first iteration of the activity processing, for example evaluating a database query.

Overrides:
processFirst in class Activity

processBlock

public void processBlock()
Description copied from class: Activity
Performs an iteration of the processing of an activity. This may involve reading a block of input data and writing a block of output data, or may involve some other kind of processing. When an activity is processed by the OGSA-DAI engine, this method will be invoked repeatedly until the activity either completes or stops due to an error or termination call. An implementation of this method should invoke the setCompleted method to indicate that processing is complete, or the setError method if an error occurs that will prevent the processing from completing.

Specified by:
processBlock in class Activity

listToCommaSeparatedString

private java.lang.String listToCommaSeparatedString(java.util.List list)
Convert a list of strings into a comma-separated list.

Parameters:
list - The list to convert
Returns:
the converted list
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD