Package org.apache.sling.api.wrappers
Class SlingRequestPaths
- java.lang.Object
-
- org.apache.sling.api.wrappers.SlingRequestPaths
-
public class SlingRequestPaths extends Object
This class is not a "wrapper" per se, but computes the correct path info, request URI, etc. for included requests. When including a request viaRequestDispatcher
, 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.This class is not intended to be extended or instantiated because it just provides constants and static utility methods not intended to be overwritten.
-
-
Field Summary
Fields Modifier and Type Field Description static String
INCLUDE_CONTEXT_PATH
Attribute name used by the RequestDispatcher to indicate the context path of the included request, as a String.static String
INCLUDE_PATH_INFO
Attribute name used by the RequestDispatcher to indicate the path info of the included request, as a String.static String
INCLUDE_QUERY_STRING
Attribute name used by the RequestDispatcher to indicate the query string of the included request, as a String.static String
INCLUDE_REQUEST_URI
Attribute name used by the RequestDispatcher to indicate the request URI of the included request, as a String.static String
INCLUDE_SERVLET_PATH
Attribute name used by the RequestDispatcher to indicate the servlet path of the included request, as a String.
-
Constructor Summary
Constructors Constructor Description SlingRequestPaths()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static String
getContextPath(HttpServletRequest r)
Return the context path for r, using the appropriate request attribute if the request is an included one.static String
getPathInfo(HttpServletRequest r)
Return the context path for r, using the appropriate request attribute if the request is an included one.static String
getQueryString(HttpServletRequest r)
Return the query string for r, using the appropriate request attribute if the request is an included one.static String
getRequestURI(HttpServletRequest r)
Return the request URI for r, using the appropriate request attribute if the request is an included one.static String
getServletPath(HttpServletRequest r)
Return the servlet path for r, using the appropriate request attribute if the request is an included one.static boolean
isIncluded(HttpServletRequest r)
True if r is an included request, in which case it has the INCLUDE_REQUEST_URI attribute
-
-
-
Field Detail
-
INCLUDE_CONTEXT_PATH
public static final String INCLUDE_CONTEXT_PATH
Attribute name used by the RequestDispatcher to indicate the context path of the included request, as a String.- See Also:
- Constant Field Values
-
INCLUDE_PATH_INFO
public static final String INCLUDE_PATH_INFO
Attribute name used by the RequestDispatcher to indicate the path info of the included request, as a String.- See Also:
- Constant Field Values
-
INCLUDE_QUERY_STRING
public static final String INCLUDE_QUERY_STRING
Attribute name used by the RequestDispatcher to indicate the query string of the included request, as a String.- See Also:
- Constant Field Values
-
INCLUDE_REQUEST_URI
public static final String INCLUDE_REQUEST_URI
Attribute name used by the RequestDispatcher to indicate the request URI of the included request, as a String.- See Also:
- Constant Field Values
-
INCLUDE_SERVLET_PATH
public static final String INCLUDE_SERVLET_PATH
Attribute name used by the RequestDispatcher to indicate the servlet path of the included request, as a String.- See Also:
- Constant Field Values
-
-
Method Detail
-
getContextPath
public static String getContextPath(HttpServletRequest r)
Return the context path for r, using the appropriate request attribute if the request is an included one.- Parameters:
r
- The request- Returns:
- The context path.
-
getPathInfo
public static String getPathInfo(HttpServletRequest r)
Return the context path for r, using the appropriate request attribute if the request is an included one.- Parameters:
r
- The request- Returns:
- The path info.
-
getQueryString
public static String getQueryString(HttpServletRequest r)
Return the query string for r, using the appropriate request attribute if the request is an included one.- Parameters:
r
- The request- Returns:
- The query string.
-
getRequestURI
public static String getRequestURI(HttpServletRequest r)
Return the request URI for r, using the appropriate request attribute if the request is an included one.- Parameters:
r
- The request- Returns:
- The request uri.
-
getServletPath
public static String getServletPath(HttpServletRequest r)
Return the servlet path for r, using the appropriate request attribute if the request is an included one.- Parameters:
r
- The request- Returns:
- The servlet path.
-
isIncluded
public static boolean isIncluded(HttpServletRequest r)
True if r is an included request, in which case it has the INCLUDE_REQUEST_URI attribute- Parameters:
r
- The request- Returns:
true
if this is an include.
-
-