org.rvpf.http

Interface HTTPModule

All Known Implementing Classes:

AlertModule, HTTPModule.Abstract, MetadataServerModule, NoticeModule, PurgeModule, QueryModule, RPNModule, UpdateModule

public interface HTTPModule

Server context module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HTTPModule.Abstract Abstract HTTP module.
static class	HTTPModule.Context Context.

Method Summary

Modifier and Type	Method and Description
void	doEventActions(Event event) Does event actions.
void	doPendingActions() Does pending actions.
void	doSignalActions(Signal signal) Does signal actions.
String	getDefaultPath() Gets the default path for this module.
boolean	needsMetadata() Asks if this module needs metadata.
void	prepareServletContext(ServletContext servletContext) Prepares the servlet context.
boolean	setUp(HTTPServerAppImpl httpApp, Map<String,String> servlets, KeyedGroups contextProperties) Sets up this server module.
void	tearDown() Tears down what has been set up.

Method Detail

doEventActions

void doEventActions(@Nonnull
                    Event event)

Does event actions.

Parameters:

event - The event.

doPendingActions

void doPendingActions()

Does pending actions.

doSignalActions

void doSignalActions(@Nonnull
                     Signal signal)

Does signal actions.

Parameters:

signal - The signal.

getDefaultPath

@Nonnull
 @CheckReturnValue
String getDefaultPath()

Gets the default path for this module.

Returns:

The default path.

needsMetadata

@CheckReturnValue
boolean needsMetadata()

Asks if this module needs metadata.

Returns:

True if yes.

prepareServletContext

void prepareServletContext(@Nonnull
                           ServletContext servletContext)

Prepares the servlet context.

Parameters:

servletContext - The servlet context.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 HTTPServerAppImpl httpApp,
                                 @Nonnull
                                 Map<String,String> servlets,
                                 @Nonnull
                                 KeyedGroups contextProperties)

Sets up this server module.

Parameters:

httpApp - The HTTP application.

servlets - The servlets map.

contextProperties - The context properties.

Returns:

True on success.

tearDown

void tearDown()

Tears down what has been set up.