public class Response extends Object implements HttpServletResponse
Response
provides the implementation for HttpServletResponse
.
Modifier and Type | Class and Description |
---|---|
static class |
Response.OutputType |
Modifier and Type | Field and Description |
---|---|
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) . |
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 and Description |
---|
Response(HttpChannel channel,
HttpOutput out) |
public static final String SET_INCLUDE_HEADER_PREFIX
setHeader(String, String)
or
addHeader(String, String)
.public Response(HttpChannel channel, HttpOutput out)
public HttpChannel getHttpChannel()
public HttpOutput getHttpOutput()
public void reopen()
public void errorClose()
public boolean isIncluding()
public void include()
public void included()
public void addCookie(HttpCookie cookie)
public void replaceCookie(HttpCookie cookie)
cookie
- The cookie to add/replacepublic void addCookie(Cookie cookie)
addCookie
in interface HttpServletResponse
public boolean containsHeader(String name)
containsHeader
in interface HttpServletResponse
public String encodeURL(String url)
encodeURL
in interface HttpServletResponse
public String encodeRedirectURL(String url)
encodeRedirectURL
in interface HttpServletResponse
@Deprecated public String encodeUrl(String url)
encodeUrl
in interface HttpServletResponse
@Deprecated public String encodeRedirectUrl(String url)
encodeRedirectUrl
in interface HttpServletResponse
public void sendError(int sc) throws IOException
sendError
in interface HttpServletResponse
IOException
public void sendError(int code, String message) throws IOException
In addition to the servlet standard handling, this method supports some additional codes:
sendError
in interface HttpServletResponse
code
- The error codemessage
- The messageIOException
- If an IO problem occurred sending the error response.public void sendProcessing() throws IOException
IOException
- if unable to send the 102 responseHttpServletResponse.sendError(int)
public void sendRedirect(int code, String location) throws IOException
code
- the redirect status codelocation
- the location to send in Location
headersIOException
- if unable to send the redirectpublic void sendRedirect(String location) throws IOException
sendRedirect
in interface HttpServletResponse
IOException
public void setDateHeader(String name, long date)
setDateHeader
in interface HttpServletResponse
public void addDateHeader(String name, long date)
addDateHeader
in interface HttpServletResponse
public void setHeader(HttpHeader name, String value)
public void setHeader(String name, String value)
setHeader
in interface HttpServletResponse
public Collection<String> getHeaderNames()
getHeaderNames
in interface HttpServletResponse
public String getHeader(String name)
getHeader
in interface HttpServletResponse
public Collection<String> getHeaders(String name)
getHeaders
in interface HttpServletResponse
public void addHeader(String name, String value)
addHeader
in interface HttpServletResponse
public void setIntHeader(String name, int value)
setIntHeader
in interface HttpServletResponse
public void addIntHeader(String name, int value)
addIntHeader
in interface HttpServletResponse
public void setStatus(int sc)
setStatus
in interface HttpServletResponse
@Deprecated public void setStatus(int sc, String sm)
setStatus
in interface HttpServletResponse
public void setStatusWithReason(int sc, String sm)
public String getCharacterEncoding()
getCharacterEncoding
in interface ServletResponse
public String getContentType()
getContentType
in interface ServletResponse
public ServletOutputStream getOutputStream() throws IOException
getOutputStream
in interface ServletResponse
IOException
public boolean isWriting()
public boolean isStreaming()
public boolean isWritingOrStreaming()
public PrintWriter getWriter() throws IOException
getWriter
in interface ServletResponse
IOException
public void setContentLength(int len)
setContentLength
in interface ServletResponse
public long getContentLength()
public boolean isAllContentWritten(long written)
public boolean isContentComplete(long written)
public void closeOutput() throws IOException
IOException
@Deprecated public void completeOutput() throws IOException
closeOutput()
IOException
public void completeOutput(Callback callback)
public long getLongContentLength()
public void setLongContentLength(long len)
public void setContentLengthLong(long length)
setContentLengthLong
in interface ServletResponse
public void setCharacterEncoding(String encoding)
setCharacterEncoding
in interface ServletResponse
public void setContentType(String contentType)
setContentType
in interface ServletResponse
public void setBufferSize(int size)
setBufferSize
in interface ServletResponse
public int getBufferSize()
getBufferSize
in interface ServletResponse
public void flushBuffer() throws IOException
flushBuffer
in interface ServletResponse
IOException
public void reset()
reset
in interface ServletResponse
public void resetContent()
public void resetForForward()
public void resetBuffer()
resetBuffer
in interface ServletResponse
public void setTrailers(Supplier<HttpFields> trailers)
public Supplier<HttpFields> getTrailers()
public MetaData.Response getCommittedMetaData()
newResponseMetaData()
if not yet committed.public boolean isCommitted()
isCommitted
in interface ServletResponse
public void setLocale(Locale locale)
setLocale
in interface ServletResponse
public Locale getLocale()
getLocale
in interface ServletResponse
public int getStatus()
getStatus
in interface HttpServletResponse
public String getReason()
public HttpFields getHttpFields()
public long getContentCount()
public void putHeaders(HttpContent content, long contentLength, boolean etag)
public static void putHeaders(HttpServletResponse response, HttpContent content, long contentLength, boolean etag)
public static HttpServletResponse unwrap(ServletResponse servletResponse)
Copyright © 2010 - 2020 Adobe. All Rights Reserved