Package org.eclipse.jetty.server

Class Response

java.lang.Object

org.eclipse.jetty.server.Response

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class Response
extends Object
implements HttpServletResponse

Response provides the implementation for HttpServletResponse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Response.OutputType

Field Summary

Fields

Modifier and Type	Field	Description
static String	HTTP_ONLY_COMMENT	If this string is found within the comment of a cookie added with addCookie(Cookie), then the cookie will be set as HTTP ONLY.
static 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).

Fields inherited from interface javax.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(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)
void	addSetRFC2965Cookie(String name, String value, String domain, String path, long maxAge, String comment, boolean isSecure, boolean isHttpOnly, int version)	Format a set cookie value
void	addSetRFC6265Cookie(String name, String value, String domain, String path, long maxAge, boolean isSecure, boolean isHttpOnly)	Format a set cookie value by RFC6265
void	closeOutput()
boolean	containsHeader(String name)
String	encodeRedirectUrl(String url)	Deprecated.
String	encodeRedirectURL(String url)
String	encodeUrl(String url)	Deprecated.
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
org.eclipse.jetty.http.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()
org.eclipse.jetty.http.HttpFields	getHttpFields()
HttpOutput	getHttpOutput()
Locale	getLocale()
long	getLongContentLength()
ServletOutputStream	getOutputStream()
String	getReason()
int	getStatus()
Supplier<org.eclipse.jetty.http.HttpFields>	getTrailers()
PrintWriter	getWriter()
void	include()
void	included()
boolean	isAllContentWritten(long written)
boolean	isCommitted()
boolean	isContentComplete(long written)
boolean	isIncluding()
boolean	isWriting()
protected org.eclipse.jetty.http.MetaData.Response	newResponseMetaData()
static void	putHeaders(HttpServletResponse response, org.eclipse.jetty.http.HttpContent content, long contentLength, boolean etag)
void	putHeaders(org.eclipse.jetty.http.HttpContent content, long contentLength, boolean etag)
protected void	recycle()
void	reset()
void	reset(boolean preserveCookies)
void	resetBuffer()
void	resetForForward()
void	sendError(int sc)
void	sendError(int code, String message)
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(String location)
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(org.eclipse.jetty.http.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 sm)	Deprecated.
void	setStatusWithReason(int sc, String sm)
void	setTrailers(Supplier<org.eclipse.jetty.http.HttpFields> trailers)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

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

HTTP_ONLY_COMMENT

public static final String HTTP_ONLY_COMMENT

If this string is found within the comment of a cookie added with addCookie(Cookie), then the cookie will be set as HTTP ONLY.

See Also:

Constant Field Values

Constructor Detail

Response

public Response(HttpChannel channel,
                HttpOutput out)

Method Detail

getHttpChannel

public HttpChannel getHttpChannel()

recycle

protected void recycle()

getHttpOutput

public HttpOutput getHttpOutput()

isIncluding

public boolean isIncluding()

include

public void include()

included

public void included()

addCookie

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

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

addSetRFC6265Cookie

public void addSetRFC6265Cookie(String name,
                                String value,
                                String domain,
                                String path,
                                long maxAge,
                                boolean isSecure,
                                boolean isHttpOnly)

Format a set cookie value by RFC6265

Parameters:

name - the name

value - the value

domain - the domain

path - the path

maxAge - the maximum age

isSecure - true if secure cookie

isHttpOnly - true if for http only

addSetRFC2965Cookie

public void addSetRFC2965Cookie(String name,
                                String value,
                                String domain,
                                String path,
                                long maxAge,
                                String comment,
                                boolean isSecure,
                                boolean isHttpOnly,
                                int version)

Format a set cookie value

Parameters:

name - the name

value - the value

domain - the domain

path - the path

maxAge - the maximum age

comment - the comment (only present on versions > 0)

isSecure - true if secure cookie

isHttpOnly - true if for http only

version - version of cookie logic to use (0 == default behavior)

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface HttpServletResponse

encodeUrl

@Deprecated
public String encodeUrl(String url)

Deprecated.

Specified by:

encodeUrl in interface HttpServletResponse

encodeRedirectUrl

@Deprecated
public String encodeRedirectUrl(String url)

Deprecated.

Specified by:

encodeRedirectUrl in interface HttpServletResponse

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendError

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

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendProcessing

public void sendProcessing()
                    throws IOException

Sends a 102-Processing response. If the connection is a HTTP connection, the version is 1.1 and the request has a 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)

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)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

setDateHeader

public void setDateHeader(String name,
                          long date)

Specified by:

setDateHeader in interface HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                          long date)

Specified by:

addDateHeader in interface HttpServletResponse

setHeader

public void setHeader(org.eclipse.jetty.http.HttpHeader name,
                      String value)

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletResponse

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletResponse

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpServletResponse

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface HttpServletResponse

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface HttpServletResponse

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:

addIntHeader in interface HttpServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface HttpServletResponse

setStatus

@Deprecated
public void setStatus(int sc,
                      String sm)

Deprecated.

Specified by:

setStatus in interface HttpServletResponse

setStatusWithReason

public void setStatusWithReason(int sc,
                                String sm)

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Throws:

IOException

isWriting

public boolean isWriting()

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Throws:

IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface 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

getLongContentLength

public long getLongContentLength()

setLongContentLength

public void setLongContentLength(long len)

setContentLengthLong

public void setContentLengthLong(long length)

Specified by:

setContentLengthLong in interface ServletResponse

setCharacterEncoding

public void setCharacterEncoding(String encoding)

Specified by:

setCharacterEncoding in interface ServletResponse

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Throws:

IOException

reset

public void reset()

Specified by:

reset in interface ServletResponse

reset

public void reset(boolean preserveCookies)

resetForForward

public void resetForForward()

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

setTrailers

public void setTrailers(Supplier<org.eclipse.jetty.http.HttpFields> trailers)

getTrailers

public Supplier<org.eclipse.jetty.http.HttpFields> getTrailers()

newResponseMetaData

protected org.eclipse.jetty.http.MetaData.Response newResponseMetaData()

getCommittedMetaData

public org.eclipse.jetty.http.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 ServletResponse

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface HttpServletResponse

getReason

public String getReason()

getHttpFields

public org.eclipse.jetty.http.HttpFields getHttpFields()

getContentCount

public long getContentCount()

toString

public String toString()

Overrides:

toString in class Object

putHeaders

public void putHeaders(org.eclipse.jetty.http.HttpContent content,
                       long contentLength,
                       boolean etag)

putHeaders

public static void putHeaders(HttpServletResponse response,
                              org.eclipse.jetty.http.HttpContent content,
                              long contentLength,
                              boolean etag)