uk.org.ogsadai.client.toolkit.activity.delivery
Class DeliverToSMTP

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.delivery.DeliverToSMTP

public class DeliverToSMTP

extends Activity

This activity creates and sends an e-mail containing data from another activity.

It has one input and no output.

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private java.util.List	mRecipients E-mail recipients - list of java.lang.String
private java.lang.String	mSender E-mail sender
private java.lang.String	mServer E-mail server
private java.lang.String	mSubject E-mail subject line

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

Constructor Summary

DeliverToSMTP()
Constructs a request to deliver data via SMTP.

DeliverToSMTP(java.util.List recipients, java.lang.String sender, java.lang.String subject, java.lang.String server)
Constructs a request to deliver data via SMTP.

Method Summary

void	addRecipient(java.lang.String recipient) Add a recipient.
void	addRecipients(java.util.List recipients) Adds a list of recipients.
protected java.lang.String	generateXML() Generates the XML representing the activity.
void	setInput(ActivityOutput input) Sets the name of the output that will provide the specified input to this activity.
void	setRecipients(java.util.List recipients) Set the list of recipients.
void	setSender(java.lang.String sender) Set the sender.
void	setServer(java.lang.String server) Set the SMTP server.
void	setSubject(java.lang.String subject) Set the subject.

Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput

Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

getDataService, getName, getSession, setDataService, setSession

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

mRecipients

private java.util.List mRecipients

E-mail recipients - list of java.lang.String

mSender

private java.lang.String mSender

E-mail sender

mSubject

private java.lang.String mSubject

E-mail subject line

mServer

private java.lang.String mServer

E-mail server

Constructor Detail

DeliverToSMTP

public DeliverToSMTP()

Constructs a request to deliver data via SMTP.

DeliverToSMTP

public DeliverToSMTP(java.util.List recipients,
                     java.lang.String sender,
                     java.lang.String subject,
                     java.lang.String server)

Constructs a request to deliver data via SMTP.

Parameters:

recipients - A list of strings - e-mail addresses of recipients.

sender - The e-mail address of the sender.

subject - The subject of the e-mail.

server - The address of the SMTP server, which must be listening on port 25.

Throws:

java.lang.IllegalArgumentException - If any argument is null.

Method Detail

setInput

public void setInput(ActivityOutput input)

Sets the name of the output that will provide the specified input to this activity.

Parameters:

input - Input from another activity.

Throws:

java.lang.IllegalArgumentException - if input is null.

setRecipients

public void setRecipients(java.util.List recipients)

Set the list of recipients.

Parameters:

recipients - A list of strings - e-mail addresses of recipients.

Throws:

java.lang.IllegalArgumentException - if recipients is null.

addRecipient

public void addRecipient(java.lang.String recipient)

Add a recipient.

Parameters:

recipient - The e-mail address of the recipient.

Throws:

java.lang.IllegalArgumentException - if recipient is null.

addRecipients

public void addRecipients(java.util.List recipients)

Adds a list of recipients.

Parameters:

recipients - A list of strings - e-mail addresses of recipients.

Throws:

java.lang.IllegalArgumentException - if recipients is null.

setSender

public void setSender(java.lang.String sender)

Set the sender.

Parameters:

sender - The e-mail address of the sender.

Throws:

java.lang.IllegalArgumentException - if sender is null.

setSubject

public void setSubject(java.lang.String subject)

Set the subject.

Parameters:

subject - The subject of the e-mail.

Throws:

java.lang.IllegalArgumentException - if subject is null.

setServer

public void setServer(java.lang.String server)

Set the SMTP server.

Parameters:

server - The address of the SMTP server, which must be listening on port 25.

Throws:

java.lang.IllegalArgumentException - if server is null.

generateXML

protected java.lang.String generateXML()

Description copied from class: RequestComponent

Generates the XML representing the activity. This XML can then be inserted into a perform document that is sent to a data service.

Specified by:

generateXML in class Activity

Returns:

the XML for the activity