org.rvpf.http.query

Class QueryModule

Object

HTTPModule.Abstract

QueryModule

All Implemented Interfaces:

HTTPModule

public final class QueryModule
extends HTTPModule.Abstract

Query 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	COUNT_PATH Count path.
static String	DEFAULT_PATH Default path.
static String	INFO_PATH Info path.
static String	QUERY_REQUESTER_ATTRIBUTE Query requester attribute.
static String	VALUES_PATH Values path.

Fields inherited from class HTTPModule.Abstract

MODULE_UUID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
QueryModule()

Method Summary

Modifier and Type	Method and Description
protected void	addServlets(Map<String,String> servlets) Adds the servlets to the servlets map.
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.
void	tearDown() Tears down what has been set up.

Methods inherited from class HTTPModule.Abstract

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

Methods inherited from class Object

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

Field Detail

COUNT_PATH

public static final String COUNT_PATH

Count path.

See Also:

Constant Field Values

DEFAULT_PATH

public static final String DEFAULT_PATH

Default path.

See Also:

Constant Field Values

INFO_PATH

public static final String INFO_PATH

Info path.

See Also:

Constant Field Values

VALUES_PATH

public static final String VALUES_PATH

Values path.

See Also:

Constant Field Values

QUERY_REQUESTER_ATTRIBUTE

public static final String QUERY_REQUESTER_ATTRIBUTE

Query requester attribute.

See Also:

Constant Field Values

Constructor Detail

QueryModule

public QueryModule()

Method Detail

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.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface HTTPModule

Overrides:

tearDown in class HTTPModule.Abstract

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.