org.gridgain.grid.kernal.processors.email

Class GridEmailProcessorAdapter

java.lang.Object

org.gridgain.grid.kernal.processors.GridProcessorAdapter

org.gridgain.grid.kernal.processors.email.GridEmailProcessorAdapter

All Implemented Interfaces:

GridComponent, GridProcessor

Direct Known Subclasses:

GridNoopEmailProcessor

public abstract class GridEmailProcessorAdapter
extends GridProcessorAdapter

Email processor.

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.GridProcessorAdapter

ctx, log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridEmailProcessorAdapter(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
abstract GridFuture<Boolean>	schedule(String subj, String body, boolean html) Schedules sending of given email to all admin emails, if any.
abstract GridFuture<Boolean>	schedule(String subj, String body, boolean html, Collection<String> addrs) Schedules sending of given email.
abstract void	sendNow(String subj, String body, boolean html) Sends given email to all admin emails, if any, in the current thread blocking until it's either successfully sent or failed.
abstract void	sendNow(String subj, String body, boolean html, Collection<String> addrs) Sends given email in the current thread blocking until it's either successfully sent or failed.

Methods inherited from class org.gridgain.grid.kernal.processors.GridProcessorAdapter

addAttributes, assertParameter, collectDiscoveryData, onDiscoveryDataReceived, onKernalStart, onKernalStop, printMemoryStats, start, stop, toString, validateNode

Methods inherited from class java.lang.Object

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

Constructor Detail

GridEmailProcessorAdapter

protected GridEmailProcessorAdapter(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

sendNow

public abstract void sendNow(String subj,
           String body,
           boolean html)
                      throws GridException

Sends given email to all admin emails, if any, in the current thread blocking until it's either successfully sent or failed. If SMTP is disabled or admin emails are not provided - this method is no-op.

Parameters:

subj - Email subject.

body - Email body.

html - HTML format flag.

Throws:

GridException - Thrown in case of any failure on sending.

sendNow

public abstract void sendNow(String subj,
           String body,
           boolean html,
           Collection<String> addrs)
                      throws GridException

Sends given email in the current thread blocking until it's either successfully sent or failed. If SMTP is disabled - this method is no-op.

Parameters:

subj - Email subject.

body - Email body.

html - HTML format flag.

addrs - Addresses.

Throws:

GridException - Thrown in case of any failure on sending.

schedule

public abstract GridFuture<Boolean> schedule(String subj,
                           String body,
                           boolean html)

Schedules sending of given email to all admin emails, if any. If SMTP is disabled or admin emails are not provided - this method is no-op. Emails will be send asynchronously from a different thread. If email sending fails - the error log will be created for each email.

Parameters:

subj - Email subject.

body - Email body.

html - HTML format flag.

Returns:

Future for scheduled email.

schedule

public abstract GridFuture<Boolean> schedule(String subj,
                           String body,
                           boolean html,
                           Collection<String> addrs)

Schedules sending of given email. If SMTP is disabled - this method is no-op. Emails will be send asynchronously from a different thread. If email sending fails - the error log will be created for each email.

Parameters:

subj - Email subject.

body - Email body.

html - HTML format flag.

addrs - Addresses.

Returns:

Future for scheduled email.