|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.sling.api.SlingConstants
public class SlingConstants
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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String |
ERROR_MESSAGE
The name of the request attribute containing the message of the error situation (value is "javax.servlet.error.message"). |
static java.lang.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 java.lang.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 java.lang.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 java.lang.String |
NAMESPACE_PREFIX
The namespace prefix used throughout Sling (value is "sling"). |
static java.lang.String |
NAMESPACE_URI_ROOT
The namespace URI prefix to be used by Sling projects to define namespaces (value is "http://sling.apache.org/"). |
static java.lang.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 java.lang.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 java.lang.String |
PROPERTY_PATH
The name of the event property holding the resource path. |
static java.lang.String |
PROPERTY_RESOURCE_SUPER_TYPE
The name of the event property holding the resource super type. |
static java.lang.String |
PROPERTY_RESOURCE_TYPE
The name of the event property holding the resource type. |
static java.lang.String |
TOPIC_ADAPTER_FACTORY_ADDED
The topic for the OSGi event which is sent when an adapter factory has been added. |
static java.lang.String |
TOPIC_ADAPTER_FACTORY_REMOVED
The topic for the OSGi event which is sent when an adapter factory has been removed. |
static java.lang.String |
TOPIC_RESOURCE_ADDED
The topic for the OSGi event which is sent when a resource has been added to the resource tree. |
static java.lang.String |
TOPIC_RESOURCE_CHANGED
The topic for the OSGi event which is sent when a resource has been changed in the resource tree. |
static java.lang.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 java.lang.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 java.lang.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 |
---|
public static final java.lang.String NAMESPACE_PREFIX
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.
public static final java.lang.String NAMESPACE_URI_ROOT
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"
.
public static final java.lang.String ATTR_REQUEST_SERVLET
Servlet
which included the servlet currently being active (value is
"org.apache.sling.api.include.servlet"). This attribute is
null
if the current servlet is the servlet handling the
client request.
The type of the attribute value is javax.servlet.Servlet
.
public static final java.lang.String ATTR_REQUEST_CONTENT
Resource
underlying the Servlet
which included the servlet
currently being active (value is
"org.apache.sling.api.include.resource"). This attribute is
null
if the current servlet is the servlet handling the
client request.
The type of the attribute value is
org.apache.sling.api.resource.Resource
.
public static final java.lang.String ERROR_EXCEPTION
The type of the attribute value is java.lang.Throwable
.
public static final java.lang.String ERROR_EXCEPTION_TYPE
Throwable
itself.
The type of the attribute value is java.lang.String
.
public static final java.lang.String ERROR_MESSAGE
Throwable.getMessage()
. If error handling is caused by a
call to one of the SlingHttpServletResponse.sendError
methods, this attribute contains the optional message.
The type of the attribute value is java.lang.String
.
public static final java.lang.String ERROR_REQUEST_URI
SlingHttpServletRequest.getRequestURI()
method.
The type of the attribute value is java.lang.String
.
public static final java.lang.String ERROR_SERVLET_NAME
The type of the attribute value is java.lang.String
.
public static final java.lang.String ERROR_STATUS
The type of the attribute value is java.lang.Integer
.
public static final java.lang.String TOPIC_RESOURCE_ADDED
PROPERTY_PATH
, PROPERTY_RESOURCE_SUPER_TYPE
and PROPERTY_RESOURCE_TYPE
poperties.
public static final java.lang.String TOPIC_RESOURCE_REMOVED
PROPERTY_PATH
.As the resource has already been removed
no further information like resource type etc. might be available.
public static final java.lang.String TOPIC_RESOURCE_CHANGED
PROPERTY_PATH
, PROPERTY_RESOURCE_SUPER_TYPE
and PROPERTY_RESOURCE_TYPE
poperties.
public static final java.lang.String TOPIC_RESOURCE_PROVIDER_ADDED
PROPERTY_PATH
property.
public static final java.lang.String TOPIC_RESOURCE_PROVIDER_REMOVED
PROPERTY_PATH
property.
public static final java.lang.String PROPERTY_PATH
public static final java.lang.String PROPERTY_RESOURCE_TYPE
public static final java.lang.String PROPERTY_RESOURCE_SUPER_TYPE
public static final java.lang.String TOPIC_ADAPTER_FACTORY_ADDED
PROPERTY_ADAPTABLE_CLASSES
,
and PROPERTY_ADAPTER_CLASSES
poperties.
public static final java.lang.String TOPIC_ADAPTER_FACTORY_REMOVED
PROPERTY_ADAPTABLE_CLASSES
,
and PROPERTY_ADAPTER_CLASSES
poperties.
public static final java.lang.String PROPERTY_ADAPTABLE_CLASSES
public static final java.lang.String PROPERTY_ADAPTER_CLASSES
Constructor Detail |
---|
public SlingConstants()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |