org.openhubframework.openhub.core.alerts

Class EmailAlertListenerSupport

java.lang.Object

org.openhubframework.openhub.core.alerts.EmailAlertListenerSupport

All Implemented Interfaces:

AlertListener

@Service
public class EmailAlertListenerSupport
extends Object
implements AlertListener

Listener implementation that sends email notifications to admin mails.

If alert is activated then email is sent - there are default subject and body but if there are defined subject or body for specified alert then these values are used. Also formats for subject and body can be changed.

Since:

0.4

Author:

Petr Juza

Constructor Summary

Constructors

Constructor and Description
EmailAlertListenerSupport()

Method Summary

Modifier and Type	Method and Description
protected void	doOnAlert(AlertInfo alert) Does action when specified alert is activated.
protected String	formatBody(AlertInfo alert, long actualCount) Formats custom body from specified alert.
protected String	formatSubject(AlertInfo alert) Formats custom subject from specified alert.
protected EmailService	getEmailService() Gets email service.
void	onAlert(AlertInfo alert, long actualCount) Default implementation is to send email notification.
protected void	sendEmail(String subject, String body) Sends notification email to administrators.
boolean	supports(AlertInfo alert) Does this listener support the specified alert?

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailAlertListenerSupport

public EmailAlertListenerSupport()

Method Detail

supports

public boolean supports(AlertInfo alert)

Description copied from interface: AlertListener

Does this listener support the specified alert?

Specified by:

supports in interface AlertListener

Parameters:

alert - that is activated

Returns:

true if specified alert is supported by this listener otherwise false

See Also:

CoreAlertsEnum

onAlert

public final void onAlert(AlertInfo alert,
                          long actualCount)

Default implementation is to send email notification. If you need to implement whatever else then override doOnAlert(AlertInfo) with custom actions.

Specified by:

onAlert in interface AlertListener

Parameters:

alert - the activated alert

actualCount - the actual count of items

doOnAlert

protected void doOnAlert(AlertInfo alert)

Does action when specified alert is activated.

Parameters:

alert - the activated alert

formatSubject

protected String formatSubject(AlertInfo alert)

Formats custom subject from specified alert. Format uses the following values in the same order:

• alert identification

Override this method if you want to change subject formatting.

Parameters:

alert - the activated alert

Returns:

formatted subject

formatBody

protected String formatBody(AlertInfo alert,
                            long actualCount)

Formats custom body from specified alert. Format uses the following values in the same order:

• actual count
• alert limit

Override this method if you want to change body formatting.

Parameters:

alert - the activated alert

actualCount - the actual count of items

Returns:

formatted body

sendEmail

protected final void sendEmail(String subject,
                               String body)

Sends notification email to administrators.

Parameters:

subject - the subject

body - the body

getEmailService

protected final EmailService getEmailService()

Gets email service.

Returns:

email service