org.apache.cocoon
Class Constants

java.lang.Object
  org.apache.cocoon.Constants

public final class Constants
extends Object

The Constants use throughout the core of the Cocoon engine.

Version:

CVS $Id: Constants.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Stefano Mazzocchi, Peter Royal

Field Summary

static String	ACTION_PARAM The request parameter name to trigger a specific action.
static String	ACTION_PARAM_PREFIX The request parameter prefix to trigger a specific action.
static String	COMPLETE_NAME The full name of this project.
static String	CONF_VERSION The version of the configuration schema
static String	CONTEXT_CACHE_DIR Application Context Key for the cache directory path
static String	CONTEXT_CLASS_LOADER Application Context Key for the global classloader
static String	CONTEXT_CLASSPATH Application Context Key for the current classpath
static String	CONTEXT_CONFIG_URL Application Context Key for the URL to the configuration file (usually named cocoon.xconf)
static String	CONTEXT_DEFAULT_ENCODING Application Context Key for the default encoding
static String	CONTEXT_ENVIRONMENT_CONTEXT Application Context Key for the environmental Context
static String	CONTEXT_UPLOAD_DIR Application Context Key for the upload directory path
static String	CONTEXT_WORK_DIR Application Context Key for the work directory path
static String	DEFAULT_CONF_FILE How a default configuration file is named.
static String	DEFAULT_CONTEXT_DIR The directory to use as context root.
static String	DEFAULT_DEST_DIR The diretory to use to use for the generated output.
static String	DEFAULT_PARSER The name of the class for the default XML parser to use
static String	DEFAULT_WORK_DIR The diretory to use for generated files.
static String	DEPRECATED_PARSER_PROPERTY Deprecated. This will be removed in future release
static boolean	DESCRIPTOR_RELOADABLE_DEFAULT Should descriptors be reloaded?
static String	ERROR_NAMESPACE_PREFIX The namespace prefix for the Error/Exception XML
static String	ERROR_NAMESPACE_URI The namespace URI for the Error/Exception XML
static String	INDEX_URI The default URI to be used when a URI requested refers to a directory, e.g. http://localhost:8080/site/
static String	LINK_COLLECTION_OBJECT Key of the List for collecting links.
static String	LINK_CONTENT_TYPE Mime-type for the link view FIXME(GP): Isn't this Environment specific?
static String	LINK_CRAWLING_ROLE Don't know exactly what this is for (and it is not used in the code base)
static String	LINK_OBJECT Key of the Map of index translation table.
static String	LINK_VIEW Name of the request value for the link view FIXME(GP): Isn't this Environment specific?
static String	NAME The name of this project.
static String	NOTIFYING_OBJECT The name of a NotifyingObject in the so called objectModel Map.
static String	PARSER_PROPERTY The name of the property holding the class for a XML parser
static String	RELOAD_PARAM The request parameter name to reload the configuration.
static String	SHOWTIME_PARAM The request parameter name to add a line of the request duration.
static String	VERSION The version of this build.
static String	VIEW_PARAM The request parameter name to request a specific view of a resource.
static String	XML_NAMESPACE_URI The URI for xml namespaces
static String	XSP_COOKIE_PREFIX The namespace prefix for the cookie logicsheet.
static String	XSP_COOKIE_URI The namespace for the cookie logicsheet.
static String	XSP_FORMVALIDATOR_PATH Don't know exactly what this is for.
static String	XSP_REQUEST_PREFIX The namespace prefix for the request logicsheet.
static String	XSP_REQUEST_URI The namespace for the request logicsheet.
static String	XSP_RESPONSE_PREFIX The namespace prefix for the response logicsheet.
static String	XSP_RESPONSE_URI The namespace for the response logicsheet.
static String	XSP_URI The namespace for the XSP core logicsheet.
static String	YEAR The year of the build

Constructor Summary

Constants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of this project.

VERSION

public static final String VERSION

The version of this build.

COMPLETE_NAME

public static final String COMPLETE_NAME

The full name of this project.

CONF_VERSION

public static final String CONF_VERSION

The version of the configuration schema

See Also:

Constant Field Values

YEAR

public static final String YEAR

The year of the build

RELOAD_PARAM

public static final String RELOAD_PARAM

The request parameter name to reload the configuration. FIXME(GP): Isn't this Servlet specific?

See Also:

Constant Field Values

SHOWTIME_PARAM

public static final String SHOWTIME_PARAM

The request parameter name to add a line of the request duration. FIXME(GP): Isn't this Servlet specific?

See Also:

Constant Field Values

VIEW_PARAM

public static final String VIEW_PARAM

The request parameter name to request a specific view of a resource. FIXME(GP): Isn't this Servlet specific?

See Also:

Constant Field Values

ACTION_PARAM

public static final String ACTION_PARAM

The request parameter name to trigger a specific action. FIXME(GP): Isn't this Servlet specific?

See Also:

Constant Field Values

ACTION_PARAM_PREFIX

public static final String ACTION_PARAM_PREFIX

The request parameter prefix to trigger a specific action. FIXME(GP): Isn't this Servlet specific?

See Also:

Constant Field Values

PARSER_PROPERTY

public static final String PARSER_PROPERTY

The name of the property holding the class for a XML parser

See Also:

Constant Field Values

DEFAULT_PARSER

public static final String DEFAULT_PARSER

The name of the class for the default XML parser to use

See Also:

Constant Field Values

DEPRECATED_PARSER_PROPERTY

public static final String DEPRECATED_PARSER_PROPERTY

Deprecated. This will be removed in future release

The name of the property holding the class for a XML parser

See Also:

Constant Field Values

XSP_URI

public static final String XSP_URI

The namespace for the XSP core logicsheet.

See Also:

Constant Field Values

XSP_REQUEST_PREFIX

public static final String XSP_REQUEST_PREFIX

The namespace prefix for the request logicsheet. FIXME(GP): Would logicsheets belong to the core?

See Also:

Constant Field Values

XSP_REQUEST_URI

public static final String XSP_REQUEST_URI

The namespace for the request logicsheet. FIXME(GP): Would logicsheets belong to the core?

See Also:

Constant Field Values

XSP_RESPONSE_PREFIX

public static final String XSP_RESPONSE_PREFIX

The namespace prefix for the response logicsheet. FIXME(GP): Would logicsheets belong to the core?

See Also:

Constant Field Values

XSP_RESPONSE_URI

public static final String XSP_RESPONSE_URI

The namespace for the response logicsheet. FIXME(GP): Would logicsheets belong to the core?

See Also:

Constant Field Values

XSP_COOKIE_PREFIX

public static final String XSP_COOKIE_PREFIX

The namespace prefix for the cookie logicsheet. FIXME(GP): Would logicsheets belong to the core?

See Also:

Constant Field Values

XSP_COOKIE_URI

public static final String XSP_COOKIE_URI

The namespace for the cookie logicsheet. FIXME(GP): Would logicsheets belong to the core?

See Also:

Constant Field Values

XSP_FORMVALIDATOR_PATH

public static final String XSP_FORMVALIDATOR_PATH

Don't know exactly what this is for. (I can guess it's for the FormValidator) FIXME(GP): Isn't this component specific?

See Also:

Constant Field Values

XML_NAMESPACE_URI

public static final String XML_NAMESPACE_URI

The URI for xml namespaces

See Also:

Constant Field Values

LINK_CONTENT_TYPE

public static final String LINK_CONTENT_TYPE

Mime-type for the link view FIXME(GP): Isn't this Environment specific?

See Also:

Constant Field Values

LINK_VIEW

public static final String LINK_VIEW

Name of the request value for the link view FIXME(GP): Isn't this Environment specific?

See Also:

Constant Field Values

LINK_CRAWLING_ROLE

public static final String LINK_CRAWLING_ROLE

Don't know exactly what this is for (and it is not used in the code base)

See Also:

Constant Field Values

LINK_OBJECT

public static final String LINK_OBJECT

Key of the Map of index translation table.

Presence of this Map in the ObjectModel indicates to the Sitemap that link translation mode has been requested by the environment. Sitemap adds LinkTranslator transformer to the pipeline, which replaces all the links in the input document with the links from this translation table.

TODO(VG): Move this declaration to ObjectModelHelper comment found at ObjectModelHelper(JH): LINK_OBJECT should also be moved to CommandLineEnvironment

See Also:

Constant Field Values

LINK_COLLECTION_OBJECT

public static final String LINK_COLLECTION_OBJECT

Key of the List for collecting links.

Presence of this Map in the ObjectModel indicates to the Sitemap that link gathering mode has been requested by the environment. Sitemap adds LinkGatherer transformer to the pipeline, which gathers the links in the input document into this List.

See Also:

Constant Field Values

NOTIFYING_OBJECT

public static final String NOTIFYING_OBJECT

The name of a NotifyingObject in the so called objectModel Map.

See Also:

Constant Field Values

INDEX_URI

public static final String INDEX_URI

The default URI to be used when a URI requested refers to a directory, e.g. http://localhost:8080/site/

See Also:

Constant Field Values

DEFAULT_CONTEXT_DIR

public static final String DEFAULT_CONTEXT_DIR

The directory to use as context root.

See Also:

Constant Field Values

DEFAULT_DEST_DIR

public static final String DEFAULT_DEST_DIR

The diretory to use to use for the generated output.

See Also:

Constant Field Values

DEFAULT_WORK_DIR

public static final String DEFAULT_WORK_DIR

The diretory to use for generated files.

See Also:

Constant Field Values

DEFAULT_CONF_FILE

public static final String DEFAULT_CONF_FILE

How a default configuration file is named.

See Also:

Constant Field Values

ERROR_NAMESPACE_URI

public static final String ERROR_NAMESPACE_URI

The namespace URI for the Error/Exception XML

See Also:

Constant Field Values

ERROR_NAMESPACE_PREFIX

public static final String ERROR_NAMESPACE_PREFIX

The namespace prefix for the Error/Exception XML

See Also:

Constant Field Values

CONTEXT_ENVIRONMENT_CONTEXT

public static final String CONTEXT_ENVIRONMENT_CONTEXT

Application Context Key for the environmental Context

See Also:

Constant Field Values

CONTEXT_CLASS_LOADER

public static final String CONTEXT_CLASS_LOADER

Application Context Key for the global classloader

See Also:

Constant Field Values

CONTEXT_WORK_DIR

public static final String CONTEXT_WORK_DIR

Application Context Key for the work directory path

See Also:

Constant Field Values

CONTEXT_UPLOAD_DIR

public static final String CONTEXT_UPLOAD_DIR

Application Context Key for the upload directory path

See Also:

Constant Field Values

CONTEXT_CACHE_DIR

public static final String CONTEXT_CACHE_DIR

Application Context Key for the cache directory path

See Also:

Constant Field Values

CONTEXT_CLASSPATH

public static final String CONTEXT_CLASSPATH

Application Context Key for the current classpath

See Also:

Constant Field Values

CONTEXT_CONFIG_URL

public static final String CONTEXT_CONFIG_URL

Application Context Key for the URL to the configuration file (usually named cocoon.xconf)

See Also:

Constant Field Values

CONTEXT_DEFAULT_ENCODING

public static final String CONTEXT_DEFAULT_ENCODING

Application Context Key for the default encoding

See Also:

Constant Field Values

DESCRIPTOR_RELOADABLE_DEFAULT

public static final boolean DESCRIPTOR_RELOADABLE_DEFAULT

Should descriptors be reloaded? FIXME(GP): Isn't this Action specific only?

See Also:

Constant Field Values

Constructor Detail

Constants

public Constants()