co.cask.cdap.etl.batch

Class EmailAction

java.lang.Object

co.cask.cdap.api.workflow.AbstractWorkflowAction

co.cask.cdap.etl.batch.EmailAction

All Implemented Interfaces:

WorkflowAction, Runnable

public class EmailAction
extends AbstractWorkflowAction

Sends an email to the specified email address after an ETL Batch Application run is completed. The user must specify a subject, the recipient's email address, and the sender's email address. Optional properties are a message (the WorkflowToken for the ETLBatchApplication run will be appended to the message), a host and port (defaults to localhost:25), a protocol (defaults to SMTP), and a username and password.

The action must be specified as a the only action in a list of actions in the ETLBatchConfig. It must have the name "Email" or an IllegalArgumentException will be thrown.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FROM_ADDRESS
static String	HOST
static String	MESSAGE
static String	PASSWORD
static String	PORT
static String	PROTOCOL
static String	RECIPIENT_EMAIL_ADDRESS
static String	SUBJECT
static String	USERNAME

Constructor Summary

Constructors

Constructor and Description
EmailAction(ETLStage action)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(WorkflowActionConfigurer configurer)
void	initialize(WorkflowContext context)
void	run()

Methods inherited from class co.cask.cdap.api.workflow.AbstractWorkflowAction

configure, destroy, getContext, getDescription, getName, setDescription, setName, setProperties, useDatasets, useDatasets

Methods inherited from class java.lang.Object

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

Field Detail

RECIPIENT_EMAIL_ADDRESS

public static final String RECIPIENT_EMAIL_ADDRESS

See Also:

Constant Field Values

FROM_ADDRESS

public static final String FROM_ADDRESS

See Also:

Constant Field Values

MESSAGE

public static final String MESSAGE

See Also:

Constant Field Values

SUBJECT

public static final String SUBJECT

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

PROTOCOL

public static final String PROTOCOL

See Also:

Constant Field Values

HOST

public static final String HOST

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

Constructor Detail

EmailAction

public EmailAction(ETLStage action)

Method Detail

initialize

public void initialize(WorkflowContext context)
                throws Exception

Specified by:

initialize in interface WorkflowAction

Overrides:

initialize in class AbstractWorkflowAction

Throws:

Exception

configure

public void configure(WorkflowActionConfigurer configurer)

Overrides:

configure in class AbstractWorkflowAction

run

public void run()