Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Licensed to the Apache Software Foundation (ASF) under one
3
   * or more contributor license agreements.  See the NOTICE file
4
   * distributed with this work for additional information
5
   * regarding copyright ownership.  The ASF licenses this file
6
   * to you under the Apache License, Version 2.0 (the
7
   * "License"); you may not use this file except in compliance
8
   * with the License.  You may obtain a copy of the License at
9
   *
10
  *   http://www.apache.org/licenses/LICENSE-2.0
11
  *
12
  * Unless required by applicable law or agreed to in writing,
13
  * software distributed under the License is distributed on an
14
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
  * KIND, either express or implied.  See the License for the
16
  * specific language governing permissions and limitations
17
  * under the License.
18
  */
19
 package org.apache.sling.api;

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. 
26
 
27
 public class SlingConstants {

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

The actual use depends on the environment. For example a org.apache.sling.api.resource.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. 

37
 
38
     public static final String NAMESPACE_PREFIX = "sling";

    
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 org.apache.sling.api.resource.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". 

50
 
51
     public static final String NAMESPACE_URI_ROOT = "http://sling.apache.org/";

    
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. 

61
 
62
     public static final String ATTR_REQUEST_SERVLET = "org.apache.sling.api.include.servlet";

    
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. 

73
 
74
     public static final String ATTR_REQUEST_CONTENT = "org.apache.sling.api.include.resource";

    
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. 

86
 
87
     public static final String ATTR_REQUEST_PATH_INFO = "org.apache.sling.api.include.request_path_info";

    
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.

The type of the attribute value is String.

Note: In Sling, the HttpServletRequest.getRequestURI() method will always return the same result regardless of whether it is called from the client request processing servlet or script or from an included servlet or script. This request attribute is set for compatibility with the Servlet API specification. 

107
    public static final String ATTR_INCLUDE_REQUEST_URI = "javax.servlet.include.request_uri";

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

Note: In Sling, the HttpServletRequest.getContextPath() method will always return the same result regardless of whether it is called from the client request processing servlet or script or from an included servlet or script. This request attribute is set for compatibility with the Servlet API specification. 

127
    public static final String ATTR_INCLUDE_CONTEXT_PATH = "javax.servlet.include.context_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"). 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 String.

Note: In Sling, the HttpServletRequest.getServletPath() method will always return the same result regardless of whether it is called from the client request processing servlet or script or from an included servlet or script. This request attribute is set for compatibility with the Servlet API specification. 

147
    public static final String ATTR_INCLUDE_SERVLET_PATH = "javax.servlet.include.servlet_path";

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

Note: In Sling, the HttpServletRequest.getPathInfo() method will always return the same result regardless of whether it is called from the client request processing servlet or script or from an included servlet or script. This request attribute is set for compatibility with the Servlet API specification. 

166
    public static final String ATTR_INCLUDE_PATH_INFO = "javax.servlet.include.path_info";

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

Note: In Sling, the HttpServletRequest.getQueryString() method will always return the same result regardless of whether it is called from the client request processing servlet or script or from an included servlet or script. This request attribute is set for compatibility with the Servlet API specification. 

186
    public static final String ATTR_INCLUDE_QUERY_STRING = "javax.servlet.include.query_string";
188
    // ---------- Error handling -----------------------------------------------
189

    
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. 

199
    public static final String ERROR_EXCEPTION = "javax.servlet.error.exception";

    
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. 

212
    public static final String ERROR_EXCEPTION_TYPE = "javax.servlet.error.exception_type";

    
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. 

224
    public static final String ERROR_MESSAGE = "javax.servlet.error.message";

    
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. 

234
    public static final String ERROR_REQUEST_URI = "javax.servlet.error.request_uri";

    
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. 

243
    public static final String ERROR_SERVLET_NAME = "javax.servlet.error.servlet_name";

    
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. 

258
    public static final String ERROR_STATUS = "javax.servlet.error.status_code";

    
The topic for the OSGi event which is sent when a resource has been added to the resource tree. The event contains at least the PROPERTY_PATH, PROPERTY_RESOURCE_SUPER_TYPE and PROPERTY_RESOURCE_TYPE poperties.

Since:
2.0.6
267
    public static final String TOPIC_RESOURCE_ADDED = "org/apache/sling/api/resource/Resource/ADDED";

    
The topic for the OSGi event which is sent when a resource has been removed from the resource tree. The event contains at least the PROPERTY_PATH.As the resource has already been removed no further information like resource type etc. might be available.

Since:
2.0.6
276
    public static final String TOPIC_RESOURCE_REMOVED = "org/apache/sling/api/resource/Resource/REMOVED";

    
The topic for the OSGi event which is sent when a resource has been changed in the resource tree. The event contains at least the PROPERTY_PATH, PROPERTY_RESOURCE_SUPER_TYPE and PROPERTY_RESOURCE_TYPE poperties.

Since:
2.0.6
285
    public static final String TOPIC_RESOURCE_CHANGED = "org/apache/sling/api/resource/Resource/CHANGED";

    
The topic for the OSGi event which is sent when a resource provider has been added to the resource tree. The event contains at least the PROPERTY_PATH property.

Since:
2.0.6
293
    public static final String TOPIC_RESOURCE_PROVIDER_ADDED = "org/apache/sling/api/resource/ResourceProvider/ADDED";

    
The topic for the OSGi event which is sent when a resource provider has been removed from the resource tree. The event contains at least the PROPERTY_PATH property.

Since:
2.0.6
301
    public static final String TOPIC_RESOURCE_PROVIDER_REMOVED = "org/apache/sling/api/resource/ResourceProvider/REMOVED";

    
The name of the event property holding the resource path.

Since:
2.0.6
307
    public static final String PROPERTY_PATH = "path";

    
The name of the event property holding the userid. This property is optional.

Since:
2.1.0
313
    public static final String PROPERTY_USERID = "userid";

    
The name of the event property holding the resource type.

Since:
2.0.6
319
    public static final String PROPERTY_RESOURCE_TYPE = "resourceType";

    
The name of the event property holding the resource super type.

Since:
2.0.6
325
    public static final String PROPERTY_RESOURCE_SUPER_TYPE = "resourceSuperType";

    
The topic for the OSGi event which is sent when an adapter factory has been added. The event contains at least the PROPERTY_ADAPTABLE_CLASSES, and PROPERTY_ADAPTER_CLASSES poperties.

Since:
2.0.6
333
    public static final String TOPIC_ADAPTER_FACTORY_ADDED = "org/apache/sling/api/adapter/AdapterFactory/ADDED";

    
The topic for the OSGi event which is sent when an adapter factory has been removed. The event contains at least the PROPERTY_ADAPTABLE_CLASSES, and PROPERTY_ADAPTER_CLASSES poperties.

Since:
2.0.6
341
    public static final String TOPIC_ADAPTER_FACTORY_REMOVED = "org/apache/sling/api/adapter/AdapterFactory/REMOVED";

    
The event property listing the fully qualified names of classes which can be adapted by this adapter factory (value is "adaptables"). The type of the value is a string array.

Since:
2.0.6
349
    public static final String PROPERTY_ADAPTABLE_CLASSES = "adaptables";

    
The event property listing the fully qualified names of classes to which this factory can adapt adaptables (value is "adapters"). The type of the value is a string array.

Since:
2.0.6
357
    public static final String PROPERTY_ADAPTER_CLASSES = "adapters";

    
The name of the request attribute providing the name of the currently executing servlet (value is "sling.core.current.servletName"). This attribute is set immediately before calling the Servlet.service() method and reset to any previously stored value after the service method returns.

Since:
2.1
367
    public static final String SLING_CURRENT_SERVLET_NAME = "sling.core.current.servletName";
New to GrepCode? Check out our FAQ X