|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.sling.engine.impl.request.RequestData
public class RequestData
The RequestData
class provides access to objects which are set
on a Servlet Request wide basis such as the repository session, the
persistence manager, etc.
The setup order is:
ContentData
Field Summary | |
---|---|
static int |
DEFAULT_MAX_CALL_COUNTER
The default value for the number of calls to the service(SlingHttpServletRequest, SlingHttpServletResponse)
method for a single instance of this class (value is 1000). |
static int |
DEFAULT_MAX_INCLUSION_COUNTER
The default value for the number of recursive inclusions for a single instance of this class (value is 50). |
Constructor Summary | |
---|---|
RequestData(SlingRequestProcessorImpl slingRequestProcessor,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
Method Summary | ||
---|---|---|
|
adaptTo(Object object,
Class<Type> type)
|
|
void |
dispose()
|
|
String |
getActiveServletName()
Returns the name of the currently active servlet. |
|
BufferProvider |
getBufferProvider()
|
|
int |
getBufferSize()
|
|
ContentData |
getContentData()
|
|
javax.servlet.ServletInputStream |
getInputStream()
|
|
static int |
getMaxCallCounter()
|
|
static int |
getMaxIncludeCounter()
|
|
String |
getMimeType(String fileName)
|
|
javax.servlet.ServletOutputStream |
getOutputStream()
|
|
ParameterSupport |
getParameterSupport()
|
|
BufferedReader |
getReader()
|
|
static RequestData |
getRequestData(javax.servlet.ServletRequest request)
|
|
static RequestData |
getRequestData(SlingHttpServletRequest request)
|
|
RequestProgressTracker |
getRequestProgressTracker()
|
|
ResourceResolver |
getResourceResolver()
|
|
javax.servlet.http.HttpServletRequest |
getServletRequest()
|
|
javax.servlet.http.HttpServletResponse |
getServletResponse()
|
|
SlingHttpServletRequest |
getSlingRequest()
|
|
SlingRequestProcessorImpl |
getSlingRequestProcessor()
|
|
SlingHttpServletResponse |
getSlingResponse()
|
|
PrintWriter |
getWriter()
|
|
Resource |
initResource(ResourceResolver resourceResolver)
|
|
void |
initServlet(Resource resource)
|
|
boolean |
isContentIncluded()
Returns true if request processing is currently processing
a component which has been included by
SlingHttpServletRequestDispatcher.include . |
|
ContentData |
popContent()
|
|
ContentData |
pushContent(Resource resource,
RequestPathInfo requestPathInfo)
|
|
static void |
service(SlingHttpServletRequest request,
SlingHttpServletResponse response)
Helper method to call the servlet for the current content data. |
|
String |
setActiveServletName(String servletName)
Sets the name of the currently active servlet and returns the name of the previously active servlet. |
|
void |
setBufferSize(int size)
Sets the size of the buffer to be used (by default) for output streams returned by BufferProvider.getOutputStream() or writers returned by
BufferProvider.getWriter() |
|
static void |
setMaxCallCounter(int maxCallCounter)
|
|
static void |
setMaxIncludeCounter(int maxInclusionCounter)
|
|
static void |
setSlingMainServlet(SlingMainServlet slingMainServlet)
|
|
static SlingHttpServletRequest |
toSlingHttpServletRequest(javax.servlet.ServletRequest request)
|
|
static SlingHttpServletResponse |
toSlingHttpServletResponse(javax.servlet.ServletResponse response)
|
|
static SlingHttpServletRequest |
unwrap(javax.servlet.ServletRequest request)
Unwraps the ServletRequest to a SlingHttpServletRequest. |
|
static SlingHttpServletResponse |
unwrap(javax.servlet.ServletResponse response)
Unwraps the ServletRequest to a SlingHttpServletRequest. |
|
static SlingHttpServletRequestImpl |
unwrap(SlingHttpServletRequest request)
Unwraps the SlingHttpServletRequest to a SlingHttpServletRequestImpl |
|
static SlingHttpServletResponseImpl |
unwrap(SlingHttpServletResponse response)
Unwraps a SlingHttpServletResponse to a SlingHttpServletResponseImpl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_MAX_INCLUSION_COUNTER
public static final int DEFAULT_MAX_CALL_COUNTER
service(SlingHttpServletRequest, SlingHttpServletResponse)
method for a single instance of this class (value is 1000).
Constructor Detail |
---|
public RequestData(SlingRequestProcessorImpl slingRequestProcessor, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Method Detail |
---|
public static void setMaxCallCounter(int maxCallCounter)
public static int getMaxCallCounter()
public static void setMaxIncludeCounter(int maxInclusionCounter)
public static int getMaxIncludeCounter()
public static void setSlingMainServlet(SlingMainServlet slingMainServlet)
public Resource initResource(ResourceResolver resourceResolver)
public void initServlet(Resource resource)
public void dispose()
public SlingRequestProcessorImpl getSlingRequestProcessor()
public javax.servlet.http.HttpServletRequest getServletRequest()
public javax.servlet.http.HttpServletResponse getServletResponse()
public SlingHttpServletRequest getSlingRequest()
public SlingHttpServletResponse getSlingResponse()
public static SlingHttpServletRequest unwrap(javax.servlet.ServletRequest request)
IllegalArgumentException
- If the request
is not a
SlingHttpServletRequest
and not a
ServletRequestWrapper
wrapping a
SlingHttpServletRequest
.public static SlingHttpServletRequestImpl unwrap(SlingHttpServletRequest request)
request
-
IllegalArgumentException
- If request
is not a
SlingHttpServletRequestImpl
and not
SlingHttpServletRequestWrapper
wrapping a
SlingHttpServletRequestImpl
.public static SlingHttpServletResponse unwrap(javax.servlet.ServletResponse response)
IllegalArgumentException
- If the response
is not a
SlingHttpServletResponse
and not a
ServletResponseWrapper
wrapping a
SlingHttpServletResponse
.public static SlingHttpServletResponseImpl unwrap(SlingHttpServletResponse response)
response
-
IllegalArgumentException
- If response
is not a
SlingHttpServletResponseImpl
and not
SlingHttpServletResponseWrapper
wrapping a
SlingHttpServletResponseImpl
.public static RequestData getRequestData(javax.servlet.ServletRequest request)
request
-
IllegalArgumentException
- If the request
is not a
SlingHttpServletRequest
and not a
ServletRequestWrapper
wrapping a
SlingHttpServletRequest
.public static RequestData getRequestData(SlingHttpServletRequest request)
request
-
IllegalArgumentException
- If request
is not a
SlingHttpServletRequestImpl
and not
SlingHttpServletRequestWrapper
wrapping a
SlingHttpServletRequestImpl
.public static SlingHttpServletRequest toSlingHttpServletRequest(javax.servlet.ServletRequest request)
request
-
IllegalArgumentException
- if request
is not a
HttpServletRequest
of if request
is not backed by SlingHttpServletRequestImpl
.public static SlingHttpServletResponse toSlingHttpServletResponse(javax.servlet.ServletResponse response)
response
-
IllegalArgumentException
- if response
is not a
HttpServletResponse
of if
response
is not backed by
SlingHttpServletResponseImpl
.public static void service(SlingHttpServletRequest request, SlingHttpServletResponse response) throws IOException, javax.servlet.ServletException
If the the servlet exists, the
SlingConstants.SLING_CURRENT_SERVLET_NAME
request attribute is set
to the name of that servlet and that servlet name is also set as the
currently active servlet
. After
the termination of the servlet (normal or throwing a Throwable) the
request attribute is reset to the previous value. The name of the
currently active servlet is only reset to the previous value if the
servlet terminates normally. In case of a Throwable, the active servlet
name is not reset and indicates which servlet caused the potential abort
of the request.
request
- The request object for the service methodresponse
- The response object for the service method
IOException
- May be thrown by the servlet's service method
javax.servlet.ServletException
- May be thrown by the servlet's service methodpublic ContentData pushContent(Resource resource, RequestPathInfo requestPathInfo)
public ContentData popContent()
public ContentData getContentData()
public boolean isContentIncluded()
true
if request processing is currently processing
a component which has been included by
SlingHttpServletRequestDispatcher.include
.
public ResourceResolver getResourceResolver()
public RequestProgressTracker getRequestProgressTracker()
public String setActiveServletName(String servletName)
public String getActiveServletName()
null
at the end of request processing, more precisly in
the case of an uncaught Throwable
at the end of request
processing, this is the name of the servlet causing the uncaught
Throwable
.
public <Type> Type adaptTo(Object object, Class<Type> type)
public String getMimeType(String fileName)
public BufferProvider getBufferProvider()
public int getBufferSize()
getBufferSize
in interface BufferProvider
BufferProvider.setBufferSize(int)
method.public void setBufferSize(int size)
BufferProvider
BufferProvider.getOutputStream()
or writers returned by
BufferProvider.getWriter()
setBufferSize
in interface BufferProvider
size
- The default buffersize. Negative values or zero disable
buffering.public javax.servlet.ServletOutputStream getOutputStream() throws IOException
getOutputStream
in interface BufferProvider
ServletOutputStream
whose initial buffer
size is set to BufferProvider.getBufferSize()
.
IOException
- If an error occurrs setting up the output streampublic PrintWriter getWriter() throws IOException
getWriter
in interface BufferProvider
PrintWriter
whose initial buffer size is
set to BufferProvider.getBufferSize()
.
IOException
- If an error occurrs setting up the writerpublic javax.servlet.ServletInputStream getInputStream() throws IOException
IOException
public BufferedReader getReader() throws UnsupportedEncodingException, IOException
UnsupportedEncodingException
IOException
public ParameterSupport getParameterSupport()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |