org.apache.sling.servlethelpers.internalrequests

Class SlingInternalRequest

java.lang.Object

org.apache.sling.servlethelpers.internalrequests.InternalRequest

org.apache.sling.servlethelpers.internalrequests.SlingInternalRequest

public class SlingInternalRequest
extends InternalRequest

Internal request that uses a SlingRequestProcessor. This executes the complete Sling request processing pipeline. That's the same processing than Sling uses for HTTP requests, but it's not as efficient as the ServletInternalRequest which resolves and calls a Servlet or Script directly. This variant of internal requests is useful when no Resource is available, as it builds its own Resource based on the supplied parameters to drive the Servlet/Script resolution mechanism.

Field Summary

Fields inherited from class org.apache.sling.servlethelpers.internalrequests.InternalRequest

contentType, DEFAULT_METHOD, extension, log, MDC_KEY, path, requestMethod, resourceResolver, selectorString

Constructor Summary

Constructors

Constructor and Description
SlingInternalRequest(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.engine.SlingRequestProcessor p, @NotNull java.lang.String path) Setup an internal request that uses a SlingRequestProcessor

Method Summary

Modifier and Type	Method and Description
protected void	delegateExecute(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.SlingHttpServletResponse response, org.apache.sling.api.resource.ResourceResolver resourceResolver) Execute the supplied Request
protected org.apache.sling.api.resource.Resource	getExecutionResource() Provide the Resource to use to execute the request
java.lang.String	toString() Return essential request info, used to set the logging MDC
SlingInternalRequest	withResourceSuperType(java.lang.String resourceSuperType) Sets the sling:resourceSuperType of the fake Resource used to resolve the Script or Servlet used for the internal request
SlingInternalRequest	withResourceType(java.lang.String resourceType) Sets the sling:resourceType of the fake Resource used to resolve the Script or Servlet used for the internal request

Methods inherited from class org.apache.sling.servlethelpers.internalrequests.InternalRequest

assertRequestExecuted, checkNotNull, checkNotNull, checkResponseContentType, checkStatus, execute, getResponse, getResponseAsString, getStatus, withBody, withContentType, withExtension, withParameter, withParameters, withRequestMethod, withSelectors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SlingInternalRequest

public SlingInternalRequest(@NotNull
                            @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                            @NotNull
                            @NotNull org.apache.sling.engine.SlingRequestProcessor p,
                            @NotNull
                            @NotNull java.lang.String path)

Setup an internal request that uses a SlingRequestProcessor

Method Detail

toString

public java.lang.String toString()

Return essential request info, used to set the logging MDC

Overrides:

toString in class java.lang.Object

withResourceSuperType

public SlingInternalRequest withResourceSuperType(java.lang.String resourceSuperType)

Sets the sling:resourceSuperType of the fake Resource used to resolve the Script or Servlet used for the internal request

withResourceType

public SlingInternalRequest withResourceType(java.lang.String resourceType)

Sets the sling:resourceType of the fake Resource used to resolve the Script or Servlet used for the internal request

delegateExecute

protected void delegateExecute(org.apache.sling.api.SlingHttpServletRequest request,
                               org.apache.sling.api.SlingHttpServletResponse response,
                               org.apache.sling.api.resource.ResourceResolver resourceResolver)
                        throws javax.servlet.ServletException,
                               java.io.IOException

Description copied from class: InternalRequest

Execute the supplied Request

Specified by:

delegateExecute in class InternalRequest

Throws:

javax.servlet.ServletException

java.io.IOException

getExecutionResource

protected org.apache.sling.api.resource.Resource getExecutionResource()

Description copied from class: InternalRequest

Provide the Resource to use to execute the request

Specified by:

getExecutionResource in class InternalRequest