net.sf.xaj.web
Class XmlDbWebConstants

java.lang.Object
  net.sf.xaj.web.XmlDbWebConstants

public final class XmlDbWebConstants
extends java.lang.Object

Constants for the XmlDb web package.

Version:

$Revision: 56 $ $Date: 2007-10-28 15:09:52 +1300 (Sun, 28 Oct 2007) $

Author:

matt

Nested Class Summary

static class	XmlDbWebConstants.BatchOperation The batch operation to perform.
static class	XmlDbWebConstants.BatchTask The batch task to perform.

Field Summary

static java.lang.String	BATCH_RESULT_ID_ELEMENT_NAME The XmlDb batch result ID element returned by batch commits.
static java.lang.String	ERROR_CODE_HEADER_NAME The name of the HTTP response header that will contain an error code.
static java.lang.String	ERROR_MESSAGE_HEADER_NAME The name of the HTTP response header that will contain an error message.
static java.util.concurrent.atomic.AtomicLong	LOG_ID_COUNTER A counter to use for tracking actions and assigning IDs to them, for logging.
static java.lang.String	REQUEST_PARAM_BATCH_OPERATION The request parameter name for the batch operation.
static java.lang.String	REQUEST_PARAM_BATCH_TASK The request parameter name for the batch task.
static java.lang.String	REQUEST_PARAM_BATCH_TRANSACTION_ID The request parameter name for the batch transaction ID.
static java.lang.String	REQUEST_PARAM_DELETE The request parameter name for the delete flag.
static java.lang.String	REQUEST_PARAM_LIST_VARIABLES_DELIMITER The request parameter name for the list variable delimiter data.
static java.lang.String	REQUEST_PARAM_LIST_VARIABLES_SET The request parameter name for the list variable keys data.
static java.lang.String	REQUEST_PARAM_QUERY_DIRECT The request parameter name to run a direct XQuery.
static java.lang.String	REQUEST_PARAM_QUERY_PLAN The request parameter name for the query plan flag.
static java.lang.String	REQUEST_PARAM_SERVICE_KEY The request parameter name for the XmlDb service key.
static java.lang.String	REQUEST_PARAM_VARIABLES_MAP The request parameter name for the variables Map data.
static java.lang.String	REQUEST_PARAM_XML The request parameter name for the XmlResource XML content.
static java.lang.String	REQUEST_PARAM_XML_ID The request parameter name for the XmlResource ID.
static java.lang.String	REQUEST_PARAM_XQUERY The request parameter name for the XQuery program.
static java.lang.String	STORE_RESULT_ID_ATTRIBUTE_NAME The XmlDb result attribute returned by a store request for the XmlResource ID.
static java.lang.String	TRANSACTION_ID_HEADER_NAME The name of the HTTP response header that will contain the transaction ID.
static java.lang.String	WEB_BATCH_LOG_NAME A logger name for web-based batch tracking.
static java.lang.String	WEB_QUERY_LOG_NAME A logger name for web-based query tracking.
static java.lang.String	XQUERY_RESULT_SEARCH_TIME_HEADER_NAME The name of the HTTP response header that will contain the search time (milliseconds).
static java.lang.String	XQUERY_RESULT_TOTAL_RESULTS_HEADER_NAME The name of the HTTP response header that will contain the total results number.

Constructor Summary

XmlDbWebConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MESSAGE_HEADER_NAME

public static final java.lang.String ERROR_MESSAGE_HEADER_NAME

The name of the HTTP response header that will contain an error message.

See Also:

Constant Field Values

ERROR_CODE_HEADER_NAME

public static final java.lang.String ERROR_CODE_HEADER_NAME

The name of the HTTP response header that will contain an error code.

See Also:

Constant Field Values

TRANSACTION_ID_HEADER_NAME

public static final java.lang.String TRANSACTION_ID_HEADER_NAME

The name of the HTTP response header that will contain the transaction ID.

See Also:

Constant Field Values

XQUERY_RESULT_TOTAL_RESULTS_HEADER_NAME

public static final java.lang.String XQUERY_RESULT_TOTAL_RESULTS_HEADER_NAME

The name of the HTTP response header that will contain the total results number.

See Also:

Constant Field Values

XQUERY_RESULT_SEARCH_TIME_HEADER_NAME

public static final java.lang.String XQUERY_RESULT_SEARCH_TIME_HEADER_NAME

The name of the HTTP response header that will contain the search time (milliseconds).

See Also:

Constant Field Values

REQUEST_PARAM_BATCH_OPERATION

public static final java.lang.String REQUEST_PARAM_BATCH_OPERATION

The request parameter name for the batch operation.

See Also:

Constant Field Values

REQUEST_PARAM_BATCH_TASK

public static final java.lang.String REQUEST_PARAM_BATCH_TASK

The request parameter name for the batch task.

See Also:

Constant Field Values

REQUEST_PARAM_BATCH_TRANSACTION_ID

public static final java.lang.String REQUEST_PARAM_BATCH_TRANSACTION_ID

The request parameter name for the batch transaction ID.

See Also:

Constant Field Values

REQUEST_PARAM_QUERY_DIRECT

public static final java.lang.String REQUEST_PARAM_QUERY_DIRECT

The request parameter name to run a direct XQuery.

See Also:

Constant Field Values

REQUEST_PARAM_SERVICE_KEY

public static final java.lang.String REQUEST_PARAM_SERVICE_KEY

The request parameter name for the XmlDb service key.

See Also:

Constant Field Values

REQUEST_PARAM_DELETE

public static final java.lang.String REQUEST_PARAM_DELETE

The request parameter name for the delete flag.

See Also:

Constant Field Values

REQUEST_PARAM_XML

public static final java.lang.String REQUEST_PARAM_XML

The request parameter name for the XmlResource XML content.

See Also:

Constant Field Values

REQUEST_PARAM_XML_ID

public static final java.lang.String REQUEST_PARAM_XML_ID

The request parameter name for the XmlResource ID.

See Also:

Constant Field Values

REQUEST_PARAM_VARIABLES_MAP

public static final java.lang.String REQUEST_PARAM_VARIABLES_MAP

The request parameter name for the variables Map data.

See Also:

Constant Field Values

REQUEST_PARAM_LIST_VARIABLES_SET

public static final java.lang.String REQUEST_PARAM_LIST_VARIABLES_SET

The request parameter name for the list variable keys data.

See Also:

Constant Field Values

REQUEST_PARAM_LIST_VARIABLES_DELIMITER

public static final java.lang.String REQUEST_PARAM_LIST_VARIABLES_DELIMITER

The request parameter name for the list variable delimiter data.

See Also:

Constant Field Values

REQUEST_PARAM_XQUERY

public static final java.lang.String REQUEST_PARAM_XQUERY

The request parameter name for the XQuery program.

See Also:

Constant Field Values

REQUEST_PARAM_QUERY_PLAN

public static final java.lang.String REQUEST_PARAM_QUERY_PLAN

The request parameter name for the query plan flag.

See Also:

Constant Field Values

STORE_RESULT_ID_ATTRIBUTE_NAME

public static final java.lang.String STORE_RESULT_ID_ATTRIBUTE_NAME

The XmlDb result attribute returned by a store request for the XmlResource ID.

See Also:

Constant Field Values

BATCH_RESULT_ID_ELEMENT_NAME

public static final java.lang.String BATCH_RESULT_ID_ELEMENT_NAME

The XmlDb batch result ID element returned by batch commits.

See Also:

Constant Field Values

WEB_QUERY_LOG_NAME

public static final java.lang.String WEB_QUERY_LOG_NAME

A logger name for web-based query tracking.

See Also:

Constant Field Values

WEB_BATCH_LOG_NAME

public static final java.lang.String WEB_BATCH_LOG_NAME

A logger name for web-based batch tracking.

See Also:

Constant Field Values

LOG_ID_COUNTER

public static final java.util.concurrent.atomic.AtomicLong LOG_ID_COUNTER

A counter to use for tracking actions and assigning IDs to them, for logging.

Constructor Detail

XmlDbWebConstants

public XmlDbWebConstants()