Module org.eclipse.jetty.ee10.servlet

Package org.eclipse.jetty.ee10.servlet

Class ServletApiResponse

java.lang.Object

org.eclipse.jetty.ee10.servlet.ServletApiResponse

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse

Direct Known Subclasses:

ServletApiResponse.CrossContextInclude

public class ServletApiResponse
extends Object
implements jakarta.servlet.http.HttpServletResponse

The Jetty implementation of the ee10 HttpServletResponse object. This provides the bridge from the Servlet HttpServletResponse to the Jetty Core Response via the ServletContextResponse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServletApiResponse.CrossContextInclude	Servlet API wrapper for cross context included responses.

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_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_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_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletApiResponse(ServletContextResponse servletContextResponse)

Method Summary

Modifier and Type	Method	Description
void	addCookie(jakarta.servlet.http.Cookie cookie)
void	addCookie(org.eclipse.jetty.http.HttpCookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
boolean	containsHeader(String name)
String	encodeRedirectURL(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
long	getContentCount()
String	getContentType()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
jakarta.servlet.ServletOutputStream	getOutputStream()
org.eclipse.jetty.server.Response	getResponse()
ServletChannel	getServletChannel()
ServletContextHandler.ServletRequestInfo	getServletRequestInfo()
ServletContextHandler.ServletResponseInfo	getServletResponseInfo()
int	getStatus()
Supplier<Map<String,String>>	getTrailerFields()
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(int code, String location)	Sends a response with one of the 300 series redirection codes.
void	sendRedirect(String location)
void	setBufferSize(int size)
void	setCharacterEncoding(String encoding)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(String contentType)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
void	setStatus(int sc)
void	setTrailerFields(Supplier<Map<String,String>> trailers)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ServletApiResponse

protected ServletApiResponse(ServletContextResponse servletContextResponse)

Method Details

getServletChannel

public ServletChannel getServletChannel()

getServletRequestInfo

public ServletContextHandler.ServletRequestInfo getServletRequestInfo()

getServletResponseInfo

public ServletContextHandler.ServletResponseInfo getServletResponseInfo()

Returns:

The ServletContextHandler.ServletResponseInfo for the request as provided by ServletContextResponse when wrapped by the ServletContextHandler.

getResponse

public org.eclipse.jetty.server.Response getResponse()

Returns:

The core Response associated with the API response. This may differ from the ServletContextResponse as wrapped by the ServletContextHandler as it may have subsequently been wrapped before being passed to ServletChannel.associate(Request, Response, Callback).

addCookie

public void addCookie(jakarta.servlet.http.Cookie cookie)

Specified by:

addCookie in interface jakarta.servlet.http.HttpServletResponse

addCookie

public void addCookie(org.eclipse.jetty.http.HttpCookie cookie)

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface jakarta.servlet.http.HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface jakarta.servlet.http.HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse

sendError

public void sendError(int sc,
 String msg)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(int code,
 String location)
                  throws IOException

Sends a response with one of the 300 series redirection codes.

Parameters:

code - the redirect status code

location - the location to send in Location headers

Throws:

IOException - if unable to send the redirect

setDateHeader

public void setDateHeader(String name,
 long date)

Specified by:

setDateHeader in interface jakarta.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(String name,
 long date)

Specified by:

addDateHeader in interface jakarta.servlet.http.HttpServletResponse

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface jakarta.servlet.http.HttpServletResponse

addHeader

public void addHeader(String name,
 String value)

Specified by:

addHeader in interface jakarta.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(String name,
 int value)

Specified by:

setIntHeader in interface jakarta.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(String name,
 int value)

Specified by:

addIntHeader in interface jakarta.servlet.http.HttpServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface jakarta.servlet.http.HttpServletResponse

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface jakarta.servlet.http.HttpServletResponse

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface jakarta.servlet.http.HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface jakarta.servlet.http.HttpServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface jakarta.servlet.ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface jakarta.servlet.ServletResponse

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()
                                                    throws IOException

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Throws:

IOException

setCharacterEncoding

public void setCharacterEncoding(String encoding)

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface jakarta.servlet.ServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface jakarta.servlet.ServletResponse

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface jakarta.servlet.ServletResponse

getContentCount

public long getContentCount()

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface jakarta.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface jakarta.servlet.ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

Throws:

IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface jakarta.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface jakarta.servlet.ServletResponse

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface jakarta.servlet.ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface jakarta.servlet.ServletResponse

getTrailerFields

public Supplier<Map<String,String>> getTrailerFields()

Specified by:

getTrailerFields in interface jakarta.servlet.http.HttpServletResponse

setTrailerFields

public void setTrailerFields(Supplier<Map<String,String>> trailers)

Specified by:

setTrailerFields in interface jakarta.servlet.http.HttpServletResponse

toString

public String toString()

Overrides:

toString in class Object