org.apache.cocoon
Interface Constants

public interface Constants

The Constants use throughout the core of the Cocoon engine.

Version:

CVS $Id: Constants.java,v 1.11 2002/03/06 03:11:30 vgritsenko Exp $

Author:

Stefano Mazzocchi, Peter Royal

Field Summary

static java.lang.String	ACTION_PARAM The request parameter name to trigger a specific action.
static java.lang.String	ACTION_PARAM_PREFIX The request parameter prefix to trigger a specific action.
static java.lang.String	COMPLETE_NAME The full name of this project.
static java.lang.String	CONF_VERSION The version of the configuration schema
static java.lang.String	CONTEXT_CACHE_DIR Application Context Key for the cache directory path
static java.lang.String	CONTEXT_CLASS_LOADER Application Context Key for the global classloader
static java.lang.String	CONTEXT_CLASSPATH Application Context Key for the current classpath
static java.lang.String	CONTEXT_CONFIG_URL Application Context Key for the URL to the configuration file (usually named cocoon.xconf)
static java.lang.String	CONTEXT_ENVIRONMENT_CONTEXT Application Context Key for the environmental Context
static java.lang.String	CONTEXT_OBJECT Deprecated. Use the ObjectModelHelper.getContext(Map) instead.
static java.lang.String	CONTEXT_UPLOAD_DIR Application Context Key for the upload directory path
static java.lang.String	CONTEXT_WORK_DIR Application Context Key for the work directory path
static java.lang.String	DEFAULT_CONF_FILE How a default configuration file is named.
static java.lang.String	DEFAULT_CONTEXT_DIR The directory to use as context root.
static java.lang.String	DEFAULT_DEST_DIR The diretory to use to use for the generated output.
static java.lang.String	DEFAULT_PARSER The name of the class for the default XML parser to use
static java.lang.String	DEFAULT_WORK_DIR The diretory to use for generated files.
static java.lang.String	DEPRECATED_PARSER_PROPERTY Deprecated. This will be removed in future release
static boolean	DESCRIPTOR_RELOADABLE_DEFAULT Should descriptors be reloaded?
static java.lang.String	ERROR_NAMESPACE_PREFIX The namespace prefix for the Error/Exception XML
static java.lang.String	ERROR_NAMESPACE_URI The namespace URI for the Error/Exception XML
static java.lang.String	INDEX_URI Describe variable INDEX_URI here.
static java.lang.String	LINK_CONTENT_TYPE Mime-type for the link view FIXME(GP): Isn't this Environment specific?
static java.lang.String	LINK_CRAWLING_ROLE Don't know exactly what this is for (and it is not used in the code base)
static java.lang.String	LINK_OBJECT Describe variable LINK_OBJECT here.
static java.lang.String	LINK_VIEW Name of the request value for the link view FIXME(GP): Isn't this Environment specific?
static java.lang.String	NAME The name of this project.
static java.lang.String	NOTIFYING_OBJECT The name of a NotifyingObject in the so called objectModel Map.
static java.lang.String	PARSER_PROPERTY The name of the property holding the class for a XML parser
static java.lang.String	RELOAD_PARAM The request parameter name to reload the configuration.
static java.lang.String	REQUEST_OBJECT Deprecated. Use the ObjectModelHelper.getRequest(Map) instead.
static java.lang.String	RESPONSE_OBJECT Deprecated. Use the ObjectModelHelper.getResponse(Map) instead.
static java.lang.String	SESSION_STATE_ATTRIBUTE Deprecated. used only by deprecated SessionStateSelector
static java.lang.String	SHOWTIME_PARAM The request parameter name to add a line of the request duration.
static java.lang.String	TEMPDIR_PROPERTY The name of the property where temporary files will be written to.
static java.lang.String	VERSION The version of this build.
static java.lang.String	VIEW_PARAM The request parameter name to request a specific view of a resource.
static java.lang.String	XML_NAMESPACE_URI The URI for xml namespaces
static java.lang.String	XSP_COOKIE_PREFIX The namespace prefix for the cookie logicsheet.
static java.lang.String	XSP_COOKIE_URI The namespace for the cookie logicsheet.
static java.lang.String	XSP_FORMVALIDATOR_PATH Don't know exactly what this is for.
static java.lang.String	XSP_FORMVALIDATOR_PREFIX Don't know exactly what this is for.
static java.lang.String	XSP_FORMVALIDATOR_URI Don't know exactly what this is for.
static java.lang.String	XSP_PREFIX The namespace prefix for the XSP core logicsheet.
static java.lang.String	XSP_REQUEST_PREFIX The namespace prefix for the request logicsheet.
static java.lang.String	XSP_REQUEST_URI The namespace for the request logicsheet.
static java.lang.String	XSP_RESPONSE_PREFIX The namespace prefix for the response logicsheet.
static java.lang.String	XSP_RESPONSE_URI The namespace for the response logicsheet.
static java.lang.String	XSP_URI The namespace for the XSP core logicsheet.
static java.lang.String	YEAR The year of the build

Field Detail

NAME

public static final java.lang.String NAME

The name of this project.

VERSION

public static final java.lang.String VERSION

The version of this build.

COMPLETE_NAME

public static final java.lang.String COMPLETE_NAME

The full name of this project.

CONF_VERSION

public static final java.lang.String CONF_VERSION

The version of the configuration schema

YEAR

public static final java.lang.String YEAR

The year of the build

RELOAD_PARAM

public static final java.lang.String RELOAD_PARAM

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

SHOWTIME_PARAM

public static final java.lang.String SHOWTIME_PARAM

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

VIEW_PARAM

public static final java.lang.String VIEW_PARAM

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

ACTION_PARAM

public static final java.lang.String ACTION_PARAM

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

ACTION_PARAM_PREFIX

public static final java.lang.String ACTION_PARAM_PREFIX

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

TEMPDIR_PROPERTY

public static final java.lang.String TEMPDIR_PROPERTY

The name of the property where temporary files will be written to.

DEFAULT_CONTEXT_DIR

public static final java.lang.String DEFAULT_CONTEXT_DIR

The directory to use as context root. FIXME(GP): Isn't this CLI specific?

DEFAULT_DEST_DIR

public static final java.lang.String DEFAULT_DEST_DIR

The diretory to use to use for the generated output. FIXME(GP): Isn't this CLI specific?

DEFAULT_WORK_DIR

public static final java.lang.String DEFAULT_WORK_DIR

The diretory to use for generated files. FIXME(GP): Isn't this CLI specific?

DEFAULT_CONF_FILE

public static final java.lang.String DEFAULT_CONF_FILE

How a default configuration file is named. FIXME(GP): Isn't this CLI specific?

PARSER_PROPERTY

public static final java.lang.String PARSER_PROPERTY

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

DEFAULT_PARSER

public static final java.lang.String DEFAULT_PARSER

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

DEPRECATED_PARSER_PROPERTY

public static final java.lang.String DEPRECATED_PARSER_PROPERTY

Deprecated. This will be removed in future release

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

XSP_PREFIX

public static final java.lang.String XSP_PREFIX

The namespace prefix for the XSP core logicsheet.

XSP_URI

public static final java.lang.String XSP_URI

The namespace for the XSP core logicsheet.

XSP_REQUEST_PREFIX

public static final java.lang.String XSP_REQUEST_PREFIX

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

XSP_REQUEST_URI

public static final java.lang.String XSP_REQUEST_URI

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

XSP_RESPONSE_PREFIX

public static final java.lang.String XSP_RESPONSE_PREFIX

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

XSP_RESPONSE_URI

public static final java.lang.String XSP_RESPONSE_URI

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

XSP_COOKIE_PREFIX

public static final java.lang.String XSP_COOKIE_PREFIX

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

XSP_COOKIE_URI

public static final java.lang.String XSP_COOKIE_URI

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

XSP_FORMVALIDATOR_PATH

public static final java.lang.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?

XSP_FORMVALIDATOR_PREFIX

public static final java.lang.String XSP_FORMVALIDATOR_PREFIX

Don't know exactly what this is for. (I can guess it's for the FormValidator) FIXME(GP): Would logicsheets belong to the core?

XSP_FORMVALIDATOR_URI

public static final java.lang.String XSP_FORMVALIDATOR_URI

Don't know exactly what this is for. (I can guess it's for the FormValidator) FIXME(GP): Would logicsheets belong to the core?

XML_NAMESPACE_URI

public static final java.lang.String XML_NAMESPACE_URI

The URI for xml namespaces

LINK_CONTENT_TYPE

public static final java.lang.String LINK_CONTENT_TYPE

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

LINK_VIEW

public static final java.lang.String LINK_VIEW

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

LINK_CRAWLING_ROLE

public static final java.lang.String LINK_CRAWLING_ROLE

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

REQUEST_OBJECT

public static final java.lang.String REQUEST_OBJECT

Deprecated. Use the ObjectModelHelper.getRequest(Map) instead.

The name of a Request object in the so called objectModel Map. This constant is also defined in the org.apache.cocoon.environment.ObjectModelHelper class. FIXME(GP): Shouldn't this definition here be removed?

RESPONSE_OBJECT

public static final java.lang.String RESPONSE_OBJECT

Deprecated. Use the ObjectModelHelper.getResponse(Map) instead.

The name of a Response object in the so called objectModel Map. This constant is also defined in the org.apache.cocoon.environment.ObjectModelHelper class. FIXME(GP): Shouldn't this definition here be removed?

CONTEXT_OBJECT

public static final java.lang.String CONTEXT_OBJECT

Deprecated. Use the ObjectModelHelper.getContext(Map) instead.

The name of a Context object in the so called objectModel Map. This constant is also defined in the org.apache.cocoon.environment.ObjectModelHelper class. FIXME(GP): Shouldn't this definition here be removed?

LINK_OBJECT

public static final java.lang.String LINK_OBJECT

Describe variable LINK_OBJECT here.

NOTIFYING_OBJECT

public static final java.lang.String NOTIFYING_OBJECT

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

INDEX_URI

public static final java.lang.String INDEX_URI

Describe variable INDEX_URI here. FIXME(GP): It seems to be (CLI) Environment specific!

ERROR_NAMESPACE_URI

public static final java.lang.String ERROR_NAMESPACE_URI

The namespace URI for the Error/Exception XML

ERROR_NAMESPACE_PREFIX

public static final java.lang.String ERROR_NAMESPACE_PREFIX

The namespace prefix for the Error/Exception XML

CONTEXT_ENVIRONMENT_CONTEXT

public static final java.lang.String CONTEXT_ENVIRONMENT_CONTEXT

Application Context Key for the environmental Context

CONTEXT_CLASS_LOADER

public static final java.lang.String CONTEXT_CLASS_LOADER

Application Context Key for the global classloader

CONTEXT_WORK_DIR

public static final java.lang.String CONTEXT_WORK_DIR

Application Context Key for the work directory path

CONTEXT_UPLOAD_DIR

public static final java.lang.String CONTEXT_UPLOAD_DIR

Application Context Key for the upload directory path

CONTEXT_CACHE_DIR

public static final java.lang.String CONTEXT_CACHE_DIR

Application Context Key for the cache directory path

CONTEXT_CLASSPATH

public static final java.lang.String CONTEXT_CLASSPATH

Application Context Key for the current classpath

CONTEXT_CONFIG_URL

public static final java.lang.String CONTEXT_CONFIG_URL

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

SESSION_STATE_ATTRIBUTE

public static final java.lang.String SESSION_STATE_ATTRIBUTE

Deprecated. used only by deprecated SessionStateSelector

DESCRIPTOR_RELOADABLE_DEFAULT

public static final boolean DESCRIPTOR_RELOADABLE_DEFAULT

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