org.apache.shale.remoting
Class Constants

java.lang.Object
  extended by org.apache.shale.remoting.Constants

public final class Constants
extends Object

Manifest constants related to Shale Remoting support.


Field Summary
static String CLASS_RESOURCES_EXCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
static String CLASS_RESOURCES_EXCLUDES_DEFAULT
          Default value for the CLASS_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
static String CLASS_RESOURCES_INCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
static String CLASS_RESOURCES_INCLUDES_DEFAULT
          Default value for the CLASS_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
static String CLASS_RESOURCES_PARAM
          Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
static String DYNAMIC_RESOURCES_EXCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
static String DYNAMIC_RESOURCES_EXCLUDES_DEFAULT
          Default value for the DYNAMIC_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
static String DYNAMIC_RESOURCES_INCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
static String DYNAMIC_RESOURCES_INCLUDES_DEFAULT
          Default value for the DYNAMIC_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
static String DYNAMIC_RESOURCES_PARAM
          Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
static String FACES_SERVLET_NAME_PARAM
          Context initialization parameter defining the name of the Faces Servlet to be used for remoting requests.
static String FACES_SERVLET_URL_PARAM
          Context initialization parameter defining the zero-relative index of the servlet-mapping, for the specified or default FacesServlet servlet name, to use when generating URLs for resources.
static String MAPPING_CLASS
          Context initialization parameter containing the fully qualified class name of the Mapping implementation class to use.
static String MAPPINGS_ATTR
          Servlet context attribute under which the Mappings instance for this web application will be stored.
static String MAPPINGS_CLASS
          Context initialization parameter containing the fully qualified class name of the Mappings implementation class to use.
static String OTHER_RESOURCES_EXCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
static String OTHER_RESOURCES_EXCLUDES_DEFAULT
          Default value for the OTHER_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
static String OTHER_RESOURCES_INCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
static String OTHER_RESOURCES_INCLUDES_DEFAULT
          Default value for the OTHER_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
static String OTHER_RESOURCES_PARAM
          Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
static String WEBAPP_RESOURCES_EXCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded.
static String WEBAPP_RESOURCES_EXCLUDES_DEFAULT
          Default value for the WEB_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.
static String WEBAPP_RESOURCES_INCLUDES
          Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included.
static String WEBAPP_RESOURCES_INCLUDES_DEFAULT
          Default value for the WEB_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.
static String WEBAPP_RESOURCES_PARAM
          Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_RESOURCES_EXCLUDES

public static final String CLASS_RESOURCES_EXCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded. If not specified, the value of constant CLASS_RESOURCES_EXCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

CLASS_RESOURCES_EXCLUDES_DEFAULT

public static final String CLASS_RESOURCES_EXCLUDES_DEFAULT

Default value for the CLASS_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.

IMPLEMENTATION NOTE - The default exclude list defined here will be prepended to any exclude list provided by the application, with the result that it is not possible to configure this processor to deliver resources matching these patterns.

Since:
1.0.4
See Also:
Constant Field Values

CLASS_RESOURCES_INCLUDES

public static final String CLASS_RESOURCES_INCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included. If not specified, the value of constant CLASS_RESOURCES_INCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

CLASS_RESOURCES_INCLUDES_DEFAULT

public static final String CLASS_RESOURCES_INCLUDES_DEFAULT

Default value for the CLASS_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.

Since:
1.0.4
See Also:
Constant Field Values

CLASS_RESOURCES_PARAM

public static final String CLASS_RESOURCES_PARAM

Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern. If no such parameter is specified, the default value (/static/*:org.apache.shale.remoting.impl.ClassResourceProcessor) is used. The Mapping instance for each pair will be configured with Mechanism.CLASS_RESOURCE.

See Also:
Constant Field Values

DYNAMIC_RESOURCES_EXCLUDES

public static final String DYNAMIC_RESOURCES_EXCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded. If not specified, the value of constant DYNAMIC_RESOURCES_EXCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

DYNAMIC_RESOURCES_EXCLUDES_DEFAULT

public static final String DYNAMIC_RESOURCES_EXCLUDES_DEFAULT

Default value for the DYNAMIC_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.

IMPLEMENTATION NOTE - The default exclude list defined here will be prepended to any exclude list provided by the application, with the result that it is not possible to configure this processor to deliver resources matching these patterns.

Since:
1.0.4
See Also:
Constant Field Values

DYNAMIC_RESOURCES_INCLUDES

public static final String DYNAMIC_RESOURCES_INCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included. If not specified, the value of constant DYNAMIC_RESOURCES_INCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

DYNAMIC_RESOURCES_INCLUDES_DEFAULT

public static final String DYNAMIC_RESOURCES_INCLUDES_DEFAULT

Default value for the DYNAMIC_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.

Since:
1.0.4

DYNAMIC_RESOURCES_PARAM

public static final String DYNAMIC_RESOURCES_PARAM

Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern. If no such parameter is specified, the default value (/dynamic/*:org.apache.shale.remoting.impl.MethodBindingProcessor) is used. The Mapping instance for each pair will be configured with Mechanism.DYNAMIC_RESOURCE.

See Also:
Constant Field Values

FACES_SERVLET_NAME_PARAM

public static final String FACES_SERVLET_NAME_PARAM

Context initialization parameter defining the name of the Faces Servlet to be used for remoting requests. If not specified, the last (or only) servlet definition for a servlet whose class is javax.faces.webapp.FacesServlet is used.

See Also:
Constant Field Values

FACES_SERVLET_URL_PARAM

public static final String FACES_SERVLET_URL_PARAM

Context initialization parameter defining the zero-relative index of the servlet-mapping, for the specified or default FacesServlet servlet name, to use when generating URLs for resources. If not specified, the default value is zero, meaning that the first servlet mapping (in the order listed in web.xml) will be used.

Since:
1.0.4
See Also:
Constant Field Values

MAPPING_CLASS

public static final String MAPPING_CLASS

Context initialization parameter containing the fully qualified class name of the Mapping implementation class to use. If not specified, org.apache.shale.remoting.impl.MappingImpl is used.

See Also:
Constant Field Values

MAPPINGS_ATTR

public static final String MAPPINGS_ATTR

Servlet context attribute under which the Mappings instance for this web application will be stored.

See Also:
Constant Field Values

MAPPINGS_CLASS

public static final String MAPPINGS_CLASS

Context initialization parameter containing the fully qualified class name of the Mappings implementation class to use. If not specified, org.apache.shale.remoting.impl.MappingsImpl is used.

See Also:
Constant Field Values

OTHER_RESOURCES_EXCLUDES

public static final String OTHER_RESOURCES_EXCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded. If not specified, the value of constant OTHER_RESOURCES_EXCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

OTHER_RESOURCES_EXCLUDES_DEFAULT

public static final String OTHER_RESOURCES_EXCLUDES_DEFAULT

Default value for the OTHER_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.

IMPLEMENTATION NOTE - The default exclude list defined here will be prepended to any exclude list provided by the application, with the result that it is not possible to configure this processor to deliver resources matching these patterns.

Since:
1.0.4
See Also:
Constant Field Values

OTHER_RESOURCES_INCLUDES

public static final String OTHER_RESOURCES_INCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included. If not specified, the value of constant OTHER_RESOURCES_INCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

OTHER_RESOURCES_INCLUDES_DEFAULT

public static final String OTHER_RESOURCES_INCLUDES_DEFAULT

Default value for the OTHER_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.

Since:
1.0.4
See Also:
Constant Field Values

OTHER_RESOURCES_PARAM

public static final String OTHER_RESOURCES_PARAM

Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern. No defaults for this mechanism are defined. The Mapping instance for each pair will be configured with Mechanism.OTHER_RESOURCE.

See Also:
Constant Field Values

WEBAPP_RESOURCES_EXCLUDES

public static final String WEBAPP_RESOURCES_EXCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly excluded. If not specified, the value of constant WEB_RESOURCES_EXCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

WEBAPP_RESOURCES_EXCLUDES_DEFAULT

public static final String WEBAPP_RESOURCES_EXCLUDES_DEFAULT

Default value for the WEB_RESOURCES_EXCLUDES context initialization parameter if no explicit value is specified.

IMPLEMENTATION NOTE - The default exclude list defined here will be prepended to any exclude list provided by the application, with the result that it is not possible to configure this processor to deliver resources matching these patterns.

Since:
1.0.4
See Also:
Constant Field Values

WEBAPP_RESOURCES_INCLUDES

public static final String WEBAPP_RESOURCES_INCLUDES

Context initialization parameter containing a comma-delimited list of URL matching patterns for resource identifiers that will be explicitly included. If not specified, the value of constant WEB_RESOURCES_INCLUDES_DEFAULT will be used.

Since:
1.0.4
See Also:
Constant Field Values

WEBAPP_RESOURCES_INCLUDES_DEFAULT

public static final String WEBAPP_RESOURCES_INCLUDES_DEFAULT

Default value for the WEB_RESOURCES_INCLUDES context initialization parameter if no explicit value is specified.

Since:
1.0.4
See Also:
Constant Field Values

WEBAPP_RESOURCES_PARAM

public static final String WEBAPP_RESOURCES_PARAM

Context initialization parameter containing a comma-delimited list of colon-delimited pairs, with each pair representing a URL matching pattern (such as /foo/* or *.foo) and the fully qualified class name of a Processor class to use for handling requests that match the specified pattern. If no such parameter is specified, the default value (/webapp/*:org.apache.shale.remoting.impl.MethodBindingProcessor) is used. The Mapping instance for each pair will be configured with Mechanism.WEBAPP_RESOURCE.

See Also:
Constant Field Values


Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.