Package org.apache.sling.servlethelpers.internalrequests

Class JakartaInternalRequest

java.lang.Object

org.apache.sling.servlethelpers.internalrequests.BaseInternalRequest

org.apache.sling.servlethelpers.internalrequests.JakartaInternalRequest

Direct Known Subclasses:

JakartaServletInternalRequest, JakartaSlingInternalRequest

public abstract class JakartaInternalRequest
extends BaseInternalRequest

Fluent helper for Sling internal requests. The ServletInternalRequest and SlingInternalRequest subclasses provide two modes for executing the internal requests, one that's very similar to the way Sling executes an HTTP request and another one that's faster by calling Servlets or Scripts directly.

Field Summary

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

bodyReader, contentType, DEFAULT_METHOD, explicitStatusCheck, extension, log, MDC_KEY, parameters, path, requestMethod, resourceResolver, selectorString

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JakartaInternalRequest(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull String path)	Clients use subclasses of this one

Method Summary

Modifier and Type	Method	Description
protected void	assertRequestExecuted()
JakartaInternalRequest	checkResponseContentType(String contentType)	After executing the request, checks that the response content-type is as expected.
JakartaInternalRequest	checkStatus(int... acceptableValues)	After executing the request, checks that the request status is one of the supplied values.
protected abstract void	delegateExecute(org.apache.sling.api.SlingJakartaHttpServletRequest request, org.apache.sling.api.SlingJakartaHttpServletResponse response, org.apache.sling.api.resource.ResourceResolver resourceResolver)	Execute the supplied Request
final JakartaInternalRequest	execute()	Execute the internal request.
org.apache.sling.api.SlingJakartaHttpServletResponse	getResponse()	Return the response object.
String	getResponseAsString()	Return the response as a String.
int	getStatus()	Return the response status.
JakartaInternalRequest	withBody(Reader bodyContent)	Use the supplied Reader as the request's body content
JakartaInternalRequest	withContentType(String contentType)	Set the HTTP request's Content-Type
JakartaInternalRequest	withExtension(String extension)	Sets the optional extension of the internal request, which influence the Servlet/Script resolution.
JakartaInternalRequest	withParameter(String key, Object value)	Set a request parameter
JakartaInternalRequest	withParameters(Map<String,Object> additionalParameters)	Add the supplied request parameters to the current ones
JakartaInternalRequest	withRequestMethod(String method)	Set the HTTP request method to use - defaults to GET
JakartaInternalRequest	withSelectors(String... selectors)	Sets the optional selectors of the internal request, which influence the Servlet/Script resolution.

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

checkNotNull, checkNotNull, getExecutionResource

Methods inherited from class java.lang.Object

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

Constructor Details

JakartaInternalRequest

protected JakartaInternalRequest(@NotNull
 @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
 @NotNull
 @NotNull String path)

Clients use subclasses of this one

Method Details

withRequestMethod

public JakartaInternalRequest withRequestMethod(String method)

Description copied from class: BaseInternalRequest

Set the HTTP request method to use - defaults to GET

Overrides:

withRequestMethod in class BaseInternalRequest

withContentType

public JakartaInternalRequest withContentType(String contentType)

Description copied from class: BaseInternalRequest

Set the HTTP request's Content-Type

Overrides:

withContentType in class BaseInternalRequest

withBody

public JakartaInternalRequest withBody(Reader bodyContent)

Description copied from class: BaseInternalRequest

Use the supplied Reader as the request's body content

Overrides:

withBody in class BaseInternalRequest

withSelectors

public JakartaInternalRequest withSelectors(String... selectors)

Description copied from class: BaseInternalRequest

Sets the optional selectors of the internal request, which influence the Servlet/Script resolution.

Overrides:

withSelectors in class BaseInternalRequest

withExtension

public JakartaInternalRequest withExtension(String extension)

Description copied from class: BaseInternalRequest

Sets the optional extension of the internal request, which influence the Servlet/Script resolution.

Overrides:

withExtension in class BaseInternalRequest

withParameter

public JakartaInternalRequest withParameter(String key,
 Object value)

Description copied from class: BaseInternalRequest

Set a request parameter

Overrides:

withParameter in class BaseInternalRequest

withParameters

public JakartaInternalRequest withParameters(Map<String,Object> additionalParameters)

Description copied from class: BaseInternalRequest

Add the supplied request parameters to the current ones

Overrides:

withParameters in class BaseInternalRequest

execute

public final JakartaInternalRequest execute()
                                     throws IOException

Execute the internal request. Can be called right after creating it, if no options need to be set.

Specified by:

execute in class BaseInternalRequest

Throws:

IOException - if the request was already executed, or if an error occurs during execution.

delegateExecute

protected abstract void delegateExecute(org.apache.sling.api.SlingJakartaHttpServletRequest request,
 org.apache.sling.api.SlingJakartaHttpServletResponse response,
 org.apache.sling.api.resource.ResourceResolver resourceResolver)
                                 throws jakarta.servlet.ServletException,
IOException

Execute the supplied Request

Throws:

jakarta.servlet.ServletException

IOException

assertRequestExecuted

protected void assertRequestExecuted()
                              throws IOException

Specified by:

assertRequestExecuted in class BaseInternalRequest

Throws:

IOException

checkStatus

public JakartaInternalRequest checkStatus(int... acceptableValues)
                                   throws IOException

Description copied from class: BaseInternalRequest

After executing the request, checks that the request status is one of the supplied values. If this is not called before methods that access the response, a check for a 200 OK status is done automatically unless this was called with no arguments before. This makes sure a status check is done or explicitly disabled.

Overrides:

checkStatus in class BaseInternalRequest

Parameters:

acceptableValues - providing no values means "don't care"

Throws:

IOException - if status doesn't match any of these values

checkResponseContentType

public JakartaInternalRequest checkResponseContentType(String contentType)
                                                throws IOException

After executing the request, checks that the response content-type is as expected.

Specified by:

checkResponseContentType in class BaseInternalRequest

Throws:

IOException - if the actual content-type doesn't match the expected one

getStatus

public int getStatus()
              throws IOException

Return the response status. The execute method must be called before this one.

Specified by:

getStatus in class BaseInternalRequest

Throws:

IOException - if the request hasn't been executed yet

getResponse

public org.apache.sling.api.SlingJakartaHttpServletResponse getResponse()
                                                                 throws IOException

Return the response object. The execute method must be called before this one. A check for "200 OK" status is done automatically unless checkStatus(int...) has been called before.

Throws:

IOException - if the request hasn't been executed yet or if the status check fails.

getResponseAsString

public String getResponseAsString()
                           throws IOException

Return the response as a String. The execute method must be called before this one. A check for "200 OK" status is done automatically unless checkStatus(int...) has been called before.

Specified by:

getResponseAsString in class BaseInternalRequest

Throws:

IOException - if the request hasn't been executed yet or if the status check fails.