GrepCode: org.apache.sling.api.wrappers.SlingRequestPaths (.java) - Class

Maven-Central
/
org.apache.sling / org.apache.sling.api
/
2.0.4-incubator

2.2.4
2.2.2
2.2.0
2.1.0
2.0.8
2.0.6
2.0.4-incubator
2.0.2-incubator
/
org.apache.sling.api.wrappers.SlingRequestPaths
Find Usages
Diff
Raw
Download
HTML Widget
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.wrappers;
20
 
21
 import javax.servlet.http.HttpServletRequest;

 This class is not a "wrapper" per se, but computes the correct path info,
 request URI, etc. for included requests. When including a request via
 javax.servlet.RequestDispatcher, the Servlet API specifies that target paths of
 the included request are available as request attributes.
 Request.getPathInfo(), for example will return the value for the including
 request, *not* for the included one.
30
 
31
 public class SlingRequestPaths {

    
 Attribute name used by the RequestDispatcher to indicate the context path
 of the included request, as a String.
 
36
 
37
     public static final String INCLUDE_CONTEXT_PATH = "javax.servlet.include.context_path";

    
 Attribute name used by the RequestDispatcher to indicate the path info of
 the included request, as a String.
 
42
 
43
     public static final String INCLUDE_PATH_INFO = "javax.servlet.include.path_info";

    
 Attribute name used by the RequestDispatcher to indicate the query string
 of the included request, as a String.
 
48
 
49
     public static final String INCLUDE_QUERY_STRING = "javax.servlet.include.query_string";

    
 Attribute name used by the RequestDispatcher to indicate the request URI
 of the included request, as a String.
 
54
 
55
     public static final String INCLUDE_REQUEST_URI = "javax.servlet.include.request_uri";

    
 Attribute name used by the RequestDispatcher to indicate the servlet path
 of the included request, as a String.
 
60
 
61
     public static final String INCLUDE_SERVLET_PATH = "javax.servlet.include.servlet_path";

    
 Return the context path for r, using the appropriate request attribute if
 the request is an included one.
 
66
 
67
     public static String getContextPath(HttpServletRequest r) {
68
         final String attr = (String) r.getAttribute(INCLUDE_CONTEXT_PATH);
69
         return attr != null ? attr : r.getContextPath();
70
     }

    
 Return the context path for r, using the appropriate request attribute if
 the request is an included one.
 
75
 
76
     public static String getPathInfo(HttpServletRequest r) {
77
         final String attr = (String) r.getAttribute(INCLUDE_PATH_INFO);
78
         return attr != null ? attr : r.getPathInfo();
79
     }

    
 Return the query string for r, using the appropriate request attribute if
 the request is an included one.
 
84
 
85
     public static String getQueryString(HttpServletRequest r) {
86
         final String attr = (String) r.getAttribute(INCLUDE_QUERY_STRING);
87
         return attr != null ? attr : r.getQueryString();
88
     }

    
 Return the request URI for r, using the appropriate request attribute if
 the request is an included one.
 
93
 
94
     public static String getRequestURI(HttpServletRequest r) {
95
         final String attr = (String) r.getAttribute(INCLUDE_REQUEST_URI);
96
         return attr != null ? attr : r.getRequestURI();
97
     }

    
 Return the servlet path for r, using the appropriate request attribute if
 the request is an included one.
 
102
103
    public static String getServletPath(HttpServletRequest r) {
104
        final String attr = (String) r.getAttribute(INCLUDE_SERVLET_PATH);
105
        return attr != null ? attr : r.getServletPath();
106
    }

    
 True if r is an included request, in which case it has the
 INCLUDE_REQUEST_URI attribute
 
111
112
    public static boolean isIncluded(HttpServletRequest r) {
113
        return r.getAttribute(INCLUDE_REQUEST_URI) != null;
114
    }
115
}