org.rvpf.http.alert

Class AlertModule

Object

HTTPModule.Abstract

AlertModule

All Implemented Interfaces:

HTTPModule

public final class AlertModule
extends HTTPModule.Abstract

Alert module.

Nested Class Summary

Nested classes/interfaces inherited from interface HTTPModule

HTTPModule.Abstract, HTTPModule.Context

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALERT_CONTEXT_ATTRIBUTE Alert context attribute.
static String	DEFAULT_PATH Default path.
static String	EVENTS_PATH Events path.
static String	STATUS_PATH Status path.
static String	TRIGGER_PATH Trigger path.

Fields inherited from class HTTPModule.Abstract

MODULE_UUID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AlertModule()

Method Summary

Modifier and Type	Method and Description
protected void	addServlets(Map<String,String> servlets) Adds the servlets to the servlets map.
void	doEventActions(Event event) Does event actions.
void	doPendingActions() Does pending actions.
String	getDefaultPath() Gets the default path for this module.
void	prepareServletContext(ServletContext servletContext) Prepares the servlet context.
protected boolean	setUp(KeyedGroups contextProperties) Sets up the server module.

Methods inherited from class HTTPModule.Abstract

callbackForEventActions, callbackForPendingActions, callbackForSignalActions, doSignalActions, getConfig, getMetadata, getService, getThisLogger, loadMetadata, needsMetadata, setRestartEnabled, setUp, tearDown

Methods inherited from class Object

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

Field Detail

ALERT_CONTEXT_ATTRIBUTE

public static final String ALERT_CONTEXT_ATTRIBUTE

Alert context attribute.

See Also:

Constant Field Values

DEFAULT_PATH

public static final String DEFAULT_PATH

Default path.

See Also:

Constant Field Values

EVENTS_PATH

public static final String EVENTS_PATH

Events path.

See Also:

Constant Field Values

STATUS_PATH

public static final String STATUS_PATH

Status path.

See Also:

Constant Field Values

TRIGGER_PATH

public static final String TRIGGER_PATH

Trigger path.

See Also:

Constant Field Values

Constructor Detail

AlertModule

public AlertModule()

Method Detail

doEventActions

public void doEventActions(Event event)

Does event actions.

Specified by:

doEventActions in interface HTTPModule

Overrides:

doEventActions in class HTTPModule.Abstract

Parameters:

event - The event.

doPendingActions

public void doPendingActions()

Does pending actions.

Specified by:

doPendingActions in interface HTTPModule

Overrides:

doPendingActions in class HTTPModule.Abstract

getDefaultPath

public String getDefaultPath()

Gets the default path for this module.

Returns:

The default path.

prepareServletContext

public void prepareServletContext(ServletContext servletContext)

Prepares the servlet context.

Specified by:

prepareServletContext in interface HTTPModule

Overrides:

prepareServletContext in class HTTPModule.Abstract

Parameters:

servletContext - The servlet context.

addServlets

protected void addServlets(Map<String,String> servlets)

Adds the servlets to the servlets map.

Specified by:

addServlets in class HTTPModule.Abstract

Parameters:

servlets - The servlets map.

setUp

protected boolean setUp(KeyedGroups contextProperties)

Sets up the server module.

Overrides:

setUp in class HTTPModule.Abstract

Parameters:

contextProperties - The context properties.

Returns:

True on success.