Package org.eclipse.jetty.server

Class Response

java.lang.Object

org.eclipse.jetty.server.Response

All Implemented Interfaces:

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

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

Response provides the implementation for HttpServletResponse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Response.OutputType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NO_CONTENT_LENGTH
static final String	SET_INCLUDE_HEADER_PREFIX	If a header name starts with this string, the header (stripped of the prefix) can be set during include using only setHeader(String, String) or addHeader(String, String).
static final int	USE_KNOWN_CONTENT_LENGTH

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

Constructor	Description
Response(HttpChannel channel, HttpOutput out)

Method Summary

Modifier and Type	Method	Description
void	addCookie(jakarta.servlet.http.Cookie cookie)
void	addCookie(HttpCookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
void	closeOutput()
void	completeOutput()	Deprecated. Use closeOutput()
void	completeOutput(Callback callback)
boolean	containsHeader(String name)
String	encodeRedirectUrl(String url)	Deprecated.
String	encodeRedirectURL(String url)
String	encodeUrl(String url)	Deprecated.
String	encodeURL(String url)
void	errorClose()
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
MetaData.Response	getCommittedMetaData()	Get the MetaData.Response committed for this response.
long	getContentCount()
long	getContentLength()
String	getContentType()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
HttpChannel	getHttpChannel()
HttpFields.Mutable	getHttpFields()
HttpOutput	getHttpOutput()
Locale	getLocale()
long	getLongContentLength()
jakarta.servlet.ServletOutputStream	getOutputStream()
String	getReason()
int	getStatus()
Supplier<Map<String,String>>	getTrailerFields()
Supplier<HttpFields>	getTrailers()
PrintWriter	getWriter()
void	include()
void	included()
boolean	isAllContentWritten(long written)
boolean	isCommitted()
boolean	isContentComplete(long written)
boolean	isIncluding()
boolean	isStreaming()
boolean	isWriting()
boolean	isWritingOrStreaming()
protected MetaData.Response	newResponseMetaData()
static void	putHeaders(jakarta.servlet.http.HttpServletResponse response, HttpContent content, long contentLength, boolean etag)
void	putHeaders(HttpContent content, long contentLength, boolean etag)
protected void	recycle()
void	reopen()
void	replaceCookie(HttpCookie cookie)	Replace (or add) a cookie.
void	reset()
void	resetBuffer()
void	resetContent()
void	resetForForward()
void	sendEarlyHint()	Sends a 103 Early Hint response.
void	sendError(int sc)
void	sendError(int code, String message)	Send an error response.
void	sendProcessing()	Sends a 102-Processing response.
void	sendRedirect(int code, String location)	Sends a response with one of the 300 series redirection codes.
void	sendRedirect(int code, String location, boolean consumeAll)	Sends a response with a given redirection code.
void	sendRedirect(String location)
void	sendRedirect(String location, boolean consumeAll)	Sends a response with a HTTP version appropriate 30x redirection.
void	setBufferSize(int size)
void	setCharacterEncoding(String encoding)
void	setContentLength(int len)
void	setContentLengthLong(long length)
void	setContentType(String contentType)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setHeader(HttpHeader name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
void	setLongContentLength(long len)
void	setStatus(int sc)
void	setStatus(int sc, String message)	Deprecated.
void	setStatusWithReason(int sc, String message)
void	setTrailerFields(Supplier<Map<String,String>> trailers)
void	setTrailers(Supplier<HttpFields> trailers)
static String	toRedirectURI(jakarta.servlet.http.HttpServletRequest request, String location)	Common point to generate a proper "Location" header for redirects.
String	toString()
static jakarta.servlet.http.HttpServletResponse	unwrap(jakarta.servlet.ServletResponse servletResponse)

Methods inherited from class java.lang.Object

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

Field Details

NO_CONTENT_LENGTH

public static final int NO_CONTENT_LENGTH

See Also:

• Constant Field Values

USE_KNOWN_CONTENT_LENGTH

public static final int USE_KNOWN_CONTENT_LENGTH

See Also:

• Constant Field Values

SET_INCLUDE_HEADER_PREFIX

public static final String SET_INCLUDE_HEADER_PREFIX

If a header name starts with this string, the header (stripped of the prefix) can be set during include using only setHeader(String, String) or addHeader(String, String).

See Also:

• Constant Field Values

Constructor Details

Response

public Response(HttpChannel channel,
 HttpOutput out)

Method Details

getHttpChannel

public HttpChannel getHttpChannel()

recycle

protected void recycle()

getHttpOutput

public HttpOutput getHttpOutput()

reopen

public void reopen()

errorClose

public void errorClose()

isIncluding

public boolean isIncluding()

include

public void include()

included

public void included()

addCookie

public void addCookie(HttpCookie cookie)

addCookie

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

Specified by:

addCookie in interface jakarta.servlet.http.HttpServletResponse

replaceCookie

public void replaceCookie(HttpCookie cookie)

Replace (or add) a cookie. Using name, path and domain, look for a matching set-cookie header and replace it.

Parameters:

cookie - The cookie to add/replace

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

encodeUrl

@Deprecated(since="Servlet API 2.1")
public String encodeUrl(String url)

Deprecated.

Specified by:

encodeUrl in interface jakarta.servlet.http.HttpServletResponse

encodeRedirectUrl

@Deprecated(since="Servlet API 2.1")
public String encodeRedirectUrl(String url)

Deprecated.

Specified by:

encodeRedirectUrl in interface jakarta.servlet.http.HttpServletResponse

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

sendError

public void sendError(int code,
 String message)
               throws IOException

Send an error response.

In addition to the servlet standard handling, this method supports some additional codes:

102

Send a partial PROCESSING response and allow additional responses

103

Send a partial EARLY_HINT response as per RFC8297

-1

Abort the HttpChannel and close the connection/stream

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Parameters:

code - The error code

message - The message

Throws:

IOException - If an IO problem occurred sending the error response.

sendProcessing

public void sendProcessing()
                    throws IOException

Sends a 102-Processing response. If the request had an Expect header starting with 102, then a 102 response is sent. This indicates that the request still be processed and real response can still be sent. This method is called by sendError if it is passed 102.

Throws:

IOException - if unable to send the 102 response

See Also:

• HttpServletResponse.sendError(int)

sendEarlyHint

public void sendEarlyHint()
                   throws IOException

Sends a 103 Early Hint response. Send a 103 response as per RFC8297 This method is called by sendError if it is passed 103.

Throws:

IOException - if unable to send the 103 response

See Also:

• HttpServletResponse.sendError(int)

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

sendRedirect

public void sendRedirect(String location,
 boolean consumeAll)
                  throws IOException

Sends a response with a HTTP version appropriate 30x redirection.

Parameters:

location - the location to send in Location headers

consumeAll - if True, consume any HTTP/1 request input before doing the redirection. If the input cannot be consumed without blocking, then add a `Connection: close` header to the response.

Throws:

IOException - if unable to send the redirect

sendRedirect

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

Sends a response with a given redirection code.

Parameters:

code - the redirect status code

location - the location to send in Location headers

consumeAll - if True, consume any HTTP/1 request input before doing the redirection. If the input cannot be consumed without blocking, then add a `Connection: close` header to the response.

Throws:

IOException - if unable to send the redirect

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Throws:

IOException

toRedirectURI

public static String toRedirectURI(jakarta.servlet.http.HttpServletRequest request,
 String location)

Common point to generate a proper "Location" header for redirects.

Parameters:

request - the request the redirect should be based on (needed when relative locations are provided, so that server name, scheme, port can be built out properly)

location - the location as an absolute URI or an encoded relative path. A relative path starting with '/' is relative to the root, otherwise it is relative to the request path.

Returns:

the full redirect "Location" URL (including scheme, host, port, path, etc...)

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(HttpHeader name,
 String value)

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface jakarta.servlet.http.HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames 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

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

setStatus

@Deprecated(since="Servlet API 2.1")
public void setStatus(int sc,
 String message)

Deprecated.

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

setStatusWithReason

public void setStatusWithReason(int sc,
 String message)

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

isWriting

public boolean isWriting()

isStreaming

public boolean isStreaming()

isWritingOrStreaming

public boolean isWritingOrStreaming()

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Throws:

IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface jakarta.servlet.ServletResponse

getContentLength

public long getContentLength()

isAllContentWritten

public boolean isAllContentWritten(long written)

isContentComplete

public boolean isContentComplete(long written)

closeOutput

public void closeOutput()
                 throws IOException

Throws:

IOException

completeOutput

@Deprecated
public void completeOutput()
                    throws IOException

Deprecated.

Use closeOutput()

close the output

Throws:

IOException

completeOutput

public void completeOutput(Callback callback)

getLongContentLength

public long getLongContentLength()

setLongContentLength

public void setLongContentLength(long len)

setContentLengthLong

public void setContentLengthLong(long length)

Specified by:

setContentLengthLong in interface jakarta.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(String encoding)

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletResponse

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface jakarta.servlet.ServletResponse

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

reset

public void reset()

Specified by:

reset in interface jakarta.servlet.ServletResponse

resetContent

public void resetContent()

resetForForward

public void resetForForward()

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

getTrailers

public Supplier<HttpFields> getTrailers()

setTrailers

public void setTrailers(Supplier<HttpFields> trailers)

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

newResponseMetaData

protected MetaData.Response newResponseMetaData()

getCommittedMetaData

public MetaData.Response getCommittedMetaData()

Get the MetaData.Response committed for this response. This may differ from the meta data in this response for exceptional responses (eg 4xx and 5xx responses generated by the container) and the committedMetaData should be used for logging purposes.

Returns:

The committed MetaData or a newResponseMetaData() if not yet committed.

isCommitted

public boolean isCommitted()

Specified by:

isCommitted 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

getStatus

public int getStatus()

Specified by:

getStatus in interface jakarta.servlet.http.HttpServletResponse

getReason

public String getReason()

getHttpFields

public HttpFields.Mutable getHttpFields()

getContentCount

public long getContentCount()

toString

public String toString()

Overrides:

toString in class Object

putHeaders

public void putHeaders(HttpContent content,
 long contentLength,
 boolean etag)

putHeaders

public static void putHeaders(jakarta.servlet.http.HttpServletResponse response,
 HttpContent content,
 long contentLength,
 boolean etag)

unwrap

public static jakarta.servlet.http.HttpServletResponse unwrap(jakarta.servlet.ServletResponse servletResponse)