SlingConstants (Apache Sling (Builder) 6 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.sling.api
Class SlingConstants

java.lang.Object
  org.apache.sling.api.SlingConstants

public class SlingConstants
extends Object
extends Object

The SlingConstants interface provides some symbolic constants for well known constant strings in Sling. Even though these constants will never change, it is recommended that applications refer to the symbolic constants instead of code the strings themselves.

Field Summary
`static String`	`ATTR_INCLUDE_CONTEXT_PATH` The name of the request attribute containing the `HttpServletRequest.getContextPath()` of the request which included the servlet currently being active underlying the `Servlet` which included the servlet currently being active (value is "javax.servlet.include.context_path").
`static String`	`ATTR_INCLUDE_PATH_INFO` The name of the request attribute containing the `HttpServletRequest.getPathInfo()` of the request which included the servlet currently being active underlying the `Servlet` which included the servlet currently being active (value is "javax.servlet.include.path_info").
`static String`	`ATTR_INCLUDE_QUERY_STRING` The name of the request attribute containing the `HttpServletRequest.getQueryString()` of the request which included the servlet currently being active underlying the `Servlet` which included the servlet currently being active (value is "javax.servlet.include.query_string").
`static String`	`ATTR_INCLUDE_REQUEST_URI` The name of the request attribute containing the `HttpServletRequest.getRequestURI()` of the request which included the servlet currently being active underlying the `Servlet` which included the servlet currently being active (value is "javax.servlet.include.request_uri").
`static String`	`ATTR_INCLUDE_SERVLET_PATH` The name of the request attribute containing the `HttpServletRequest.getServletPath()` of the request which included the servlet currently being active underlying the `Servlet` which included the servlet currently being active (value is "javax.servlet.include.servlet_path").
`static String`	`ATTR_REQUEST_CONTENT` The name of the request attribute containing the `Resource` underlying the `Servlet` which included the servlet currently being active (value is "org.apache.sling.api.include.resource").
`static String`	`ATTR_REQUEST_PATH_INFO` The name of the request attribute containing the `RequestPathInfo` underlying the `Servlet` which included the servlet currently being active (value is "org.apache.sling.api.include.request_path_info").
`static String`	`ATTR_REQUEST_SERVLET` The name of the request attribute containing the `Servlet` which included the servlet currently being active (value is "org.apache.sling.api.include.servlet").
`static String`	`ERROR_EXCEPTION` The name of the request attribute containing the exception thrown causing the error handler to be called (value is "javax.servlet.error.exception").
`static String`	`ERROR_EXCEPTION_TYPE` The name of the request attribute containing the fully qualified class name of the exception thrown causing the error handler to be called (value is "javax.servlet.error.exception_type").
`static String`	`ERROR_MESSAGE` The name of the request attribute containing the message of the error situation (value is "javax.servlet.error.message").
`static String`	`ERROR_REQUEST_URI` The name of the request attribute containing the URL requested by the client during whose processing the error handling was caused (value is "javax.servlet.error.request_uri").
`static String`	`ERROR_SERVLET_NAME` The name of the request attribute containing the name of the servlet which caused the error handling (value is "javax.servlet.error.servlet_name").
`static String`	`ERROR_STATUS` The name of the request attribute containing the status code sent to the client (value is "javax.servlet.error.status_code").
`static String`	`NAMESPACE_PREFIX` The namespace prefix used throughout Sling (value is "sling").
`static String`	`NAMESPACE_URI_ROOT` The namespace URI prefix to be used by Sling projects to define namespaces (value is "http://sling.apache.org/").
`static String`	`PROPERTY_ADAPTABLE_CLASSES` The event property listing the fully qualified names of classes which can be adapted by this adapter factory (value is "adaptables").
`static String`	`PROPERTY_ADAPTER_CLASSES` The event property listing the fully qualified names of classes to which this factory can adapt adaptables (value is "adapters").
`static String`	`PROPERTY_PATH` The name of the event property holding the resource path.
`static String`	`PROPERTY_RESOURCE_SUPER_TYPE` The name of the event property holding the resource super type.
`static String`	`PROPERTY_RESOURCE_TYPE` The name of the event property holding the resource type.
`static String`	`PROPERTY_USERID` The name of the event property holding the userid.
`static String`	`SLING_CURRENT_SERVLET_NAME` The name of the request attribute providing the name of the currently executing servlet (value is "sling.core.current.servletName").
`static String`	`TOPIC_ADAPTER_FACTORY_ADDED` The topic for the OSGi event which is sent when an adapter factory has been added.
`static String`	`TOPIC_ADAPTER_FACTORY_REMOVED` The topic for the OSGi event which is sent when an adapter factory has been removed.
`static String`	`TOPIC_RESOURCE_ADDED` The topic for the OSGi event which is sent when a resource has been added to the resource tree.
`static String`	`TOPIC_RESOURCE_CHANGED` The topic for the OSGi event which is sent when a resource has been changed in the resource tree.
`static String`	`TOPIC_RESOURCE_PROVIDER_ADDED` The topic for the OSGi event which is sent when a resource provider has been added to the resource tree.
`static String`	`TOPIC_RESOURCE_PROVIDER_REMOVED` The topic for the OSGi event which is sent when a resource provider has been removed from the resource tree.
`static String`	`TOPIC_RESOURCE_REMOVED` The topic for the OSGi event which is sent when a resource has been removed from the resource tree.

Constructor Summary
`SlingConstants()`

Method Summary

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

NAMESPACE_PREFIX

public static final String NAMESPACE_PREFIX

The namespace prefix used throughout Sling (value is "sling").

The actual use depends on the environment. For example a ResourceResolver using a JCR repository may name Sling node types and items using namespaces mapped to this prefix. A JSP tag library for Sling may use this prefix as the namespace prefix for its tags.

See Also:: Constant Field Values

NAMESPACE_URI_ROOT

public static final String NAMESPACE_URI_ROOT

The namespace URI prefix to be used by Sling projects to define namespaces (value is "http://sling.apache.org/").

The actual namespace URI depends on the environment. For example a ResourceResolver using a JCR repository may define its namespace as NAMESPACE_URI_ROOT + "jcr/sling/1.0". A JSP tag library for Sling may define its namespace as NAMESPACE_URI_ROOT + "taglib/sling/1.0".

See Also:: Constant Field Values

ATTR_REQUEST_SERVLET

public static final String ATTR_REQUEST_SERVLET

The name of the request attribute containing the Servlet which included the servlet currently being active (value is "org.apache.sling.api.include.servlet"). This attribute is only set if the serlvet or script is included via RequestDispatcher.include from another servlet or script.

The type of the attribute value is javax.servlet.Servlet.

See Also:: Constant Field Values

ATTR_REQUEST_CONTENT

public static final String ATTR_REQUEST_CONTENT

The name of the request attribute containing the Resource underlying the Servlet which included the servlet currently being active (value is "org.apache.sling.api.include.resource"). This attribute is only set if the serlvet or script is included via RequestDispatcher.include from another servlet or script.

The type of the attribute value is org.apache.sling.api.resource.Resource.

See Also:: Constant Field Values

ATTR_REQUEST_PATH_INFO

public static final String ATTR_REQUEST_PATH_INFO

The name of the request attribute containing the RequestPathInfo underlying the Servlet which included the servlet currently being active (value is "org.apache.sling.api.include.request_path_info"). This attribute is only set if the serlvet or script is included via RequestDispatcher.include from another servlet or script.

The type of the attribute value is org.apache.sling.api.request.RequestPathInfo.

See Also:: Constant Field Values

ATTR_INCLUDE_REQUEST_URI

public static final String ATTR_INCLUDE_REQUEST_URI

The name of the request attribute containing the HttpServletRequest.getRequestURI() of the request which included the servlet currently being active underlying the Servlet which included the servlet currently being active (value is "javax.servlet.include.request_uri"). This attribute is only set if the serlvet or script is included via RequestDispatcher.include from another servlet or script.