org.rvpf.http

Class HTTPModule.Abstract

Object

HTTPModule.Abstract

All Implemented Interfaces:

HTTPModule

Direct Known Subclasses:

AlertModule, MetadataServerModule, NoticeModule, PurgeModule, QueryModule, RPNModule, UpdateModule

Enclosing interface:

HTTPModule

@NotThreadSafe
public abstract static class HTTPModule.Abstract
extends Object
implements HTTPModule

Abstract HTTP 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	MODULE_UUID_PROPERTY The module UUID is needed when the module is a client of the metadata server.

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addServlets(Map<String,String> servlets) Adds the servlets to the servlets map.
void	callbackForEventActions() Requests a callback for event actions.
void	callbackForPendingActions() Requests a callback for pending actions.
void	callbackForSignalActions() Requests a callback for signal actions.
void	doEventActions(Event event) Does event actions.
void	doPendingActions() Does pending actions.
void	doSignalActions(Signal signal) Does signal actions.
protected Config	getConfig() Gets the config.
protected Metadata	getMetadata() Gets the metadata.
protected MetadataService	getService() Gets the service.
protected Logger	getThisLogger() Gets the logger.
protected boolean	loadMetadata(MetadataFilter metadataFilter) Loads the metadata.
boolean	needsMetadata() Asks if this module needs metadata.
void	prepareServletContext(ServletContext servletContext) Prepares the servlet context.
boolean	setRestartEnabled(boolean restartEnabled) Sets the restart enabled indicator.
boolean	setUp(HTTPServerAppImpl httpApp, Map<String,String> servlets, KeyedGroups contextProperties) Sets up this server module.
protected boolean	setUp(KeyedGroups contextProperties) Sets up the server module.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Methods inherited from interface HTTPModule

getDefaultPath

Field Detail

MODULE_UUID_PROPERTY

public static final String MODULE_UUID_PROPERTY

The module UUID is needed when the module is a client of the metadata server.

See Also:

Constant Field Values

Constructor Detail

Abstract

public Abstract()

Method Detail

callbackForEventActions

public final void callbackForEventActions()

Requests a callback for event actions.

callbackForPendingActions

public final void callbackForPendingActions()

Requests a callback for pending actions.

callbackForSignalActions

public final void callbackForSignalActions()

Requests a callback for signal actions.

doEventActions

public void doEventActions(Event event)

Does event actions.

Specified by:

doEventActions in interface HTTPModule

Parameters:

event - The event.

doPendingActions

public void doPendingActions()

Does pending actions.

Specified by:

doPendingActions in interface HTTPModule

doSignalActions

public void doSignalActions(Signal signal)

Does signal actions.

Specified by:

doSignalActions in interface HTTPModule

Parameters:

signal - The signal.

needsMetadata

public boolean needsMetadata()

Asks if this module needs metadata.

Specified by:

needsMetadata in interface HTTPModule

Returns:

True if yes.

prepareServletContext

public void prepareServletContext(ServletContext servletContext)

Prepares the servlet context.

Specified by:

prepareServletContext in interface HTTPModule

Parameters:

servletContext - The servlet context.

setRestartEnabled

@CheckReturnValue
public final boolean setRestartEnabled(boolean restartEnabled)

Sets the restart enabled indicator.

Parameters:

restartEnabled - The restart enabled indicator.

Returns:

The previous value of the indicator.

setUp

public final boolean setUp(HTTPServerAppImpl httpApp,
                           Map<String,String> servlets,
                           KeyedGroups contextProperties)

Sets up this server module.

Specified by:

setUp in interface HTTPModule

Parameters:

httpApp - The HTTP application.

servlets - The servlets map.

contextProperties - The context properties.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface HTTPModule

addServlets

protected abstract void addServlets(@Nonnull
                                    Map<String,String> servlets)

Adds the servlets to the servlets map.

Parameters:

servlets - The servlets map.

getConfig

@Nonnull
 @CheckReturnValue
protected final Config getConfig()

Gets the config.

Returns:

The config.

getMetadata

@Nonnull
 @CheckReturnValue
protected final Metadata getMetadata()

Gets the metadata.

Returns:

The metadata.

getService

@Nonnull
 @CheckReturnValue
protected final MetadataService getService()

Gets the service.

Returns:

The service.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

loadMetadata

@CheckReturnValue
protected final boolean loadMetadata(MetadataFilter metadataFilter)

Loads the metadata.

Parameters:

metadataFilter - The metadata filter.

Returns:

True on success.

setUp

@CheckReturnValue
protected boolean setUp(@Nonnull
                                           KeyedGroups contextProperties)

Sets up the server module.

Parameters:

contextProperties - The context properties.

Returns:

True on success.