Interface SlingJakartaHttpServletResponseResult
- All Superinterfaces:
Adaptable
,jakarta.servlet.http.HttpServletResponse
,jakarta.servlet.ServletResponse
,SlingJakartaHttpServletResponse
@ProviderType
public interface SlingJakartaHttpServletResponseResult
extends SlingJakartaHttpServletResponse
This is an extension of a SlingJakartaHttpServletResponse
to get the result from a processing operation.
Note: instances of this interface are not thread-safe.
- Since:
- 1.4
-
Field Summary
Fields inherited from interface jakarta.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MISDIRECTED_REQUEST, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PERMANENT_REDIRECT, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY
-
Method Summary
Modifier and TypeMethodDescriptionlong
Gets the content length@Nullable jakarta.servlet.http.Cookie
Gets the named cookie.@Nullable jakarta.servlet.http.Cookie[]
Gets all cookies.byte[]
Gets the output as a byte array.@NotNull String
Gets the output as a string.@Nullable String
Gets the status messageMethods inherited from interface jakarta.servlet.http.HttpServletResponse
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, sendRedirect, sendRedirect, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setTrailerFields
Methods inherited from interface jakarta.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
-
Method Details
-
getContentLength
long getContentLength()Gets the content length- Returns:
- the content length or
-1
if not set
-
getStatusMessage
Gets the status message- Returns:
- the status message or
null
.
-
getCookie
Gets the named cookie.- Parameters:
name
- the name of the cookie- Returns:
- the cookie or
null
if no cookie with that name exists
-
getCookies
@Nullable @Nullable jakarta.servlet.http.Cookie[] getCookies()Gets all cookies.- Returns:
- the array of cookies or
null
if no cookies were set
-
getOutput
byte[] getOutput()Gets the output as a byte array.- Returns:
- the output as a byte array
-
getOutputAsString
Gets the output as a string.- Returns:
- the output as a string
-