org.apache.sling.api
Class SlingConstants

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

public class SlingConstants
extends java.lang.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 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/").

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 java.lang.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 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/").

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 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"). 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.

See Also:

Constant Field Values

ATTR_REQUEST_CONTENT

public static final 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"). 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.

See Also:

Constant Field Values

ERROR_EXCEPTION

public static final 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"). This attribute is only available to error handling servlets and only if an exception has been thrown causing error handling.

The type of the attribute value is java.lang.Throwable.

See Also:

Constant Field Values

ERROR_EXCEPTION_TYPE

public static final 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"). This attribute is only available to error handling servlets and only if an exception has been thrown causing error handling. This attribute is present for backwards compatibility only. Error handling servlet implementors are advised to use the Throwable itself.

The type of the attribute value is java.lang.String.

See Also:

Constant Field Values

ERROR_MESSAGE

public static final java.lang.String ERROR_MESSAGE

The name of the request attribute containing the message of the error situation (value is "javax.servlet.error.message"). If an exception caused error handling, this is the exceptions message from 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.

See Also:

Constant Field Values

ERROR_REQUEST_URI

public static final 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"). This property is retrieved calling the SlingHttpServletRequest.getRequestURI() method.

The type of the attribute value is java.lang.String.

See Also:

Constant Field Values

ERROR_SERVLET_NAME

public static final 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").

The type of the attribute value is java.lang.String.

See Also:

Constant Field Values

ERROR_STATUS

public static final 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"). Error handling servlets may set this status code on their response to the client or they may choose to set another status code. For example a handler for NOT_FOUND status (404) may opt to redirect to a new location and thus not set the 404 status but a MOVED_PERMANENTLY (301) status. If this attribute is not set and the error handler is not configured to set its own status code anyway, a default value of INTERNAL_SERVER_ERROR (500) should be sent.

The type of the attribute value is java.lang.Integer.

See Also:

Constant Field Values

Constructor Detail

SlingConstants

public SlingConstants()