org.apache.cocoon
Class Constants

java.lang.Object
  extended byorg.apache.cocoon.Constants

public final class Constants
extends Object

The Constants used throughout the core of the Cocoon engine.

Version:
$Id: Constants.html 1304280 2012-03-23 11:18:01Z ilgrosso $

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 BLOCK_META_DIR
           
static String COMPLETE_NAME
          Deprecated. This will be removed soon.
static String CONF_VERSION
          The version of the configuration schema
static String CONTEXT_CACHE_DIR
          Deprecated. Use org.apache.cocoon.configuration.Settings#getCacheDirectory() instead.
static String CONTEXT_DEFAULT_ENCODING
          Deprecated. Use org.apache.cocoon.configuration.Settings#getFormEncoding().
static String CONTEXT_ENV_PREFIX
          Application Context key for the current environment prefix
static String CONTEXT_ENVIRONMENT_CONTEXT
          Application Context Key for the environmental Context (= ServletContext)
static String CONTEXT_VPC_PREFIX
          Application Context key prefix for the current sitemap virtual components
static String CONTEXT_WORK_DIR
          Deprecated. Use org.apache.cocoon.configuration.Settings#getWorkDirectory() instead.
static String DEFAULT_CONF_FILE
          Deprecated. This will be removed soon.
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_WORK_DIR
          Deprecated. This will be removed soon.
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.
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_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
          Deprecated. This will be removed soon.
static String NOTIFYING_OBJECT
          Deprecated. Usage of Notifying object has been deprecated in favor of using Exception object at ObjectModelHelper.THROWABLE_OBJECT.
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 WIRING
          Path to the wiring.xml relative to the context root directory
static String XML_NAMESPACE_URI
          The URI for xml namespaces
static String YEAR
          The year of the build
 
Constructor Summary
Constants()
           
 
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
Deprecated. This will be removed soon.

The name of this project.

See Also:
Constant Field Values

VERSION

public static final String VERSION
The version of this build.


COMPLETE_NAME

public static final String COMPLETE_NAME
Deprecated. This will be removed soon.

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


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

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_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
Deprecated. Usage of Notifying object has been deprecated in favor of using Exception object at ObjectModelHelper.THROWABLE_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
Deprecated. This will be removed soon.

The diretory to use for generated files.

See Also:
Constant Field Values

DEFAULT_CONF_FILE

public static final String DEFAULT_CONF_FILE
Deprecated. This will be removed soon.

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 (= ServletContext)

See Also:
Constant Field Values

CONTEXT_WORK_DIR

public static final String CONTEXT_WORK_DIR
Deprecated. Use org.apache.cocoon.configuration.Settings#getWorkDirectory() instead.

Application Context Key for the work directory path.

See Also:
Constant Field Values

CONTEXT_CACHE_DIR

public static final String CONTEXT_CACHE_DIR
Deprecated. Use org.apache.cocoon.configuration.Settings#getCacheDirectory() instead.

Application Context Key for the cache directory path.

See Also:
Constant Field Values

CONTEXT_ENV_PREFIX

public static final String CONTEXT_ENV_PREFIX
Application Context key for the current environment prefix

See Also:
Constant Field Values

CONTEXT_VPC_PREFIX

public static final String CONTEXT_VPC_PREFIX
Application Context key prefix for the current sitemap virtual components

See Also:
Constant Field Values

WIRING

public static final String WIRING
Path to the wiring.xml relative to the context root directory

See Also:
Constant Field Values

BLOCK_META_DIR

public static final String BLOCK_META_DIR
See Also:
Constant Field Values

CONTEXT_DEFAULT_ENCODING

public static final String CONTEXT_DEFAULT_ENCODING
Deprecated. Use org.apache.cocoon.configuration.Settings#getFormEncoding().

Application Context Key for the default encoding.

See Also:
Constant Field Values
Constructor Detail

Constants

public Constants()


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.