Class HttpServletResponseImpl
- All Implemented Interfaces:
HttpServletResponse,ServletResponse,Holders.ResponseHolder
Response object. All methods are delegated to the wrapped response.- Version:
- $Revision: 1.9 $ $Date: 2007/05/05 05:32:43 $
- Author:
- Remy Maucherat, Jean-Francois Arcand
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ResponseThe wrapped response.protected HttpServletRequestImplprotected booleanUsing output stream flag.protected booleanUsing writer flag.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
ConstructorsModifierConstructorDescriptionprotectedConstruct a wrapper for the specified response. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the specified cookie to the response.voidaddDateHeader(String name, long date) Adds a response header with the given name and date-value.voidAdds a response header with the given name and value.voidaddIntHeader(String name, int value) Adds a response header with the given name and integer value.protected Objectclone()Prevent cloning the facade.booleancontainsHeader(String name) Returns a boolean indicating whether the named response header has already been set.static HttpServletResponseImplcreate()encodeRedirectURL(String url) Encodes the specified URL for use in thesendRedirectmethod or, if encoding is not needed, returns the URL unchanged.Encodes the specified URL by including the session ID, or, if encoding is not needed, returns the URL unchanged.voidfinish()voidForces any content in the buffer to be written to the client.intReturns the actual buffer size used for the response.Returns the name of the character encoding (MIME charset) used for the body sent in this response.Returns the content type used for the MIME body sent in this response.Gets the value of the response header with the given name.Gets the names of the headers of this response.getHeaders(String string) Gets the values of the response header with the given name.Returns internal GrizzlyResponseassociated with this Holder.Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)method.Returns aServletOutputStreamsuitable for writing binary data in the response.intGets the current status code of this response.Gets the supplier of trailer headers.Returns aPrintWriterobject that can send character text to the client.voidinitialize(Response response, HttpServletRequestImpl servletRequest) booleanReturns a boolean indicating if the response has been committed.booleanisError()voidreset()Clears any data that exists in the buffer as well as the status code, headers.voidClears the content of the underlying buffer in the response without clearing headers or status code.voidsendError(int sc) Sends an error response to the client using the specified status code and clears the buffer.voidSends an error response to the client using the specified status and clears the buffer.voidsendRedirect(String location) Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.voidsetBufferSize(int size) Sets the preferred buffer size for the body of the response.voidsetCharacterEncoding(String charEnc) Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.voidsetContentLength(int len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.voidsetContentLengthLong(long len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.voidsetContentType(String type) Sets the content type of the response being sent to the client, if the response has not been committed yet.voidsetDateHeader(String name, long date) Sets a response header with the given name and date-value.voidSets a response header with the given name and value.voidsetIntHeader(String name, int value) Sets a response header with the given name and integer value.voidSets the locale of the response, if the response has not been committed yet.voidsetStatus(int sc) Sets the status code for this response.voidsetTrailerFields(Supplier<Map<String, String>> supplier) Sets the supplier of trailer headers.
-
Field Details
-
usingOutputStream
protected boolean usingOutputStreamUsing output stream flag. -
usingWriter
protected boolean usingWriterUsing writer flag. -
response
The wrapped response. -
servletRequest
-
-
Constructor Details
-
HttpServletResponseImpl
protected HttpServletResponseImpl()Construct a wrapper for the specified response.
-
-
Method Details
-
create
-
initialize
- Throws:
IOException
-
clone
Prevent cloning the facade.- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
finish
- Throws:
IOException
-
getCharacterEncoding
Returns the name of the character encoding (MIME charset) used for the body sent in this response. The following methods for specifying the response character encoding are consulted, in decreasing order of priority: per request, perweb-app (usingServletContext.setResponseCharacterEncoding(java.lang.String), deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration). The first one of these methods that yields a result is returned. Per-request, the charset for the response can be specified explicitly using theServletResponse.setCharacterEncoding(java.lang.String)andServletResponse.setContentType(java.lang.String)methods, or implicitly using the setLocale(java.util.Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods aftergetWriterhas been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified,ISO-8859-1is returned.See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
- Specified by:
getCharacterEncodingin interfaceServletResponse- Returns:
- a
Stringspecifying the name of the character encoding, for example,UTF-8
-
getOutputStream
Returns aServletOutputStreamsuitable for writing binary data in the response. The servlet container does not encode the binary data.Calling flush() on the ServletOutputStream commits the response. Either this method or
ServletResponse.getWriter()may be called to write the body, not both, except whenServletResponse.reset()has been called.- Specified by:
getOutputStreamin interfaceServletResponse- Returns:
- a
ServletOutputStreamfor writing binary data - Throws:
IOException- if an input or output exception occurred- See Also:
-
getWriter
Returns aPrintWriterobject that can send character text to the client. ThePrintWriteruses the character encoding returned byServletResponse.getCharacterEncoding(). If the response's character encoding has not been specified as described ingetCharacterEncoding(i.e., the method just returns the default valueISO-8859-1),getWriterupdates it toISO-8859-1.Calling flush() on the
PrintWritercommits the response.Either this method or
ServletResponse.getOutputStream()may be called to write the body, not both, except whenServletResponse.reset()has been called.- Specified by:
getWriterin interfaceServletResponse- Returns:
- a
PrintWriterobject that can return character data to the client - Throws:
UnsupportedEncodingException- if the character encoding returned bygetCharacterEncodingcannot be usedIOException- if an input or output exception occurred- See Also:
-
setContentLength
public void setContentLength(int len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
setContentLengthin interfaceServletResponse- Parameters:
len- an integer specifying the length of the content being returned to the client; sets the Content-Length header
-
setContentLengthLong
public void setContentLengthLong(long len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
setContentLengthLongin interfaceServletResponse- Parameters:
len- a long specifying the length of the content being returned to the client; sets the Content-Length header
-
setContentType
Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example,text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called beforeServletResponse.getWriter()is called.This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after
getWriterhas been called or after the response has been committed.If calling this method has an effect (as per the previous paragraph), calling this method with
nullclears any content type set via a previous call to this method and clears any character encoding set via a previous call to this method,ServletResponse.setCharacterEncoding(java.lang.String)orServletResponse.setLocale(java.util.Locale)but does not affect any default character encoding configured viaServletContext.setResponseCharacterEncoding(java.lang.String)or the deployment descriptor.If this method is called with an invalid or unrecognised character encoding, then a subsequent call to
ServletResponse.getWriter()will throw aUnsupportedEncodingException. Content for an unknown encoding can be sent with theServletOutputStreamreturned fromServletResponse.getOutputStream().Containers may choose to log calls to this method that use an invalid or unrecognised character encoding.
Containers must communicate the content type and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the
Content-Typeheader is used.- Specified by:
setContentTypein interfaceServletResponse- Parameters:
type- aStringspecifying the MIME type of the content ornull- See Also:
-
setBufferSize
public void setBufferSize(int size) Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found usinggetBufferSize.A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.
This method must be called before any response body content is written; if content has been written or the response object has been committed, this method throws an
IllegalStateException.- Specified by:
setBufferSizein interfaceServletResponse- Parameters:
size- the preferred buffer size- See Also:
-
getBufferSize
public int getBufferSize()Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.- Specified by:
getBufferSizein interfaceServletResponse- Returns:
- the actual buffer size used
- See Also:
-
flushBuffer
Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.- Specified by:
flushBufferin interfaceServletResponse- Throws:
IOException- if the act of flushing the buffer cannot be completed.- See Also:
-
resetBuffer
public void resetBuffer()Clears the content of the underlying buffer in the response without clearing headers or status code. If the response has been committed, this method throws anIllegalStateException.- Specified by:
resetBufferin interfaceServletResponse- See Also:
-
isCommitted
public boolean isCommitted()Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.- Specified by:
isCommittedin interfaceServletResponse- Returns:
- a boolean indicating if the response has been committed
- See Also:
-
reset
public void reset()Clears any data that exists in the buffer as well as the status code, headers. The state of callingServletResponse.getWriter()orServletResponse.getOutputStream()is also cleared. It is legal, for instance, to callServletResponse.getWriter(),ServletResponse.reset()and thenServletResponse.getOutputStream(). IfServletResponse.getWriter()orServletResponse.getOutputStream()have been called before this method, then the corrresponding returned Writer or OutputStream will be staled and the behavior of using the stale object is undefined. If the response has been committed, this method throws anIllegalStateException.- Specified by:
resetin interfaceServletResponse- See Also:
-
setLocale
Sets the locale of the response, if the response has not been committed yet. It also sets the response's character encoding appropriately for the locale, if the character encoding has not been explicitly set usingServletResponse.setContentType(java.lang.String)orServletResponse.setCharacterEncoding(java.lang.String),getWriterhasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains alocale-encoding-mapping-listelement, and that element provides a mapping for the given locale, that mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.This method may be called repeatedly to change locale and character encoding. The method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after
ServletResponse.setContentType(java.lang.String)has been called with a charset specification, afterServletResponse.setCharacterEncoding(java.lang.String)has been called, aftergetWriterhas been called, or after the response has been committed.If calling this method has an effect on the locale (as per the previous paragraph), calling this method with
nullclears any locale set via a previous call to this method. If calling this method has an effect on the character encoding, calling this method withnullclears the previously set character encoding.Containers must communicate the locale and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the locale is communicated via the
Content-Languageheader, the character encoding as part of theContent-Typeheader for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.- Specified by:
setLocalein interfaceServletResponse- Parameters:
loc- the locale of the response or {code @null}- See Also:
-
getLocale
Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)method. Calls made tosetLocaleafter the response is committed have no effect. If no locale has been specified, the container's default locale is returned.- Specified by:
getLocalein interfaceServletResponse- Returns:
- the Locale for this response.
- See Also:
-
addCookie
Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.- Specified by:
addCookiein interfaceHttpServletResponse- Parameters:
cookie- the Cookie to return to the client
-
containsHeader
Returns a boolean indicating whether the named response header has already been set.- Specified by:
containsHeaderin interfaceHttpServletResponse- Parameters:
name- the header name- Returns:
trueif the named response header has already been set;falseotherwise
-
encodeURL
Encodes the specified URL by including the session ID, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.
If the URL is relative, it is always relative to the current HttpServletRequest.
- Specified by:
encodeURLin interfaceHttpServletResponse- Parameters:
url- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
encodeRedirectURL
Encodes the specified URL for use in thesendRedirectmethod or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from theencodeURLmethod.All URLs sent to the
HttpServletResponse.sendRedirectmethod should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.If the URL is relative, it is always relative to the current HttpServletRequest.
- Specified by:
encodeRedirectURLin interfaceHttpServletResponse- Parameters:
url- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
- See Also:
-
sendError
Sends an error response to the client using the specified status and clears the buffer. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html". The caller is not responsible for escaping or re-encoding the message to ensure it is safe with respect to the current response encoding and content type. This aspect of safety is the responsibility of the container, as it is generating the error page containing the message. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response.
If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter and the msg parameter will be ignored.
If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
- Specified by:
sendErrorin interfaceHttpServletResponse- Parameters:
sc- the error status codemsg- the descriptive message- Throws:
IOException- If an input or output exception occurs
-
sendError
Sends an error response to the client using the specified status code and clears the buffer. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back the error pageIf the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
- Specified by:
sendErrorin interfaceHttpServletResponse- Parameters:
sc- the error status code- Throws:
IOException- If an input or output exception occurs
-
sendRedirect
Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer. The buffer will be replaced with the data set by this method. Calling this method sets the status code toHttpServletResponse.SC_FOUND302 (Found). This method can accept relative URLs;the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root. If the location is relative with two leading '/' the container interprets it as a network-path reference (see RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, section 4.2 "Relative Reference").If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
- Specified by:
sendRedirectin interfaceHttpServletResponse- Parameters:
location- the redirect location URL- Throws:
IOException- If an input or output exception occurs
-
getHeader
Gets the value of the response header with the given name.If a response header with the given name exists and contains multiple values, the value that was added first will be returned.
This method considers only response headers set or added via
HttpServletResponse.setHeader(java.lang.String, java.lang.String),HttpServletResponse.addHeader(java.lang.String, java.lang.String),HttpServletResponse.setDateHeader(java.lang.String, long),HttpServletResponse.addDateHeader(java.lang.String, long),HttpServletResponse.setIntHeader(java.lang.String, int), orHttpServletResponse.addIntHeader(java.lang.String, int), respectively.- Specified by:
getHeaderin interfaceHttpServletResponse- Parameters:
string- the name of the response header whose value to return- Returns:
- the value of the response header with the given name, or null if no header with the given name has been set on this response
-
getHeaderNames
Gets the names of the headers of this response.This method considers only response headers set or added via
HttpServletResponse.setHeader(java.lang.String, java.lang.String),HttpServletResponse.addHeader(java.lang.String, java.lang.String),HttpServletResponse.setDateHeader(java.lang.String, long),HttpServletResponse.addDateHeader(java.lang.String, long),HttpServletResponse.setIntHeader(java.lang.String, int), orHttpServletResponse.addIntHeader(java.lang.String, int), respectively.Any changes to the returned
Collectionmust not affect thisHttpServletResponse.- Specified by:
getHeaderNamesin interfaceHttpServletResponse- Returns:
- a (possibly empty)
Collectionof the names of the headers of this response
-
getHeaders
Gets the values of the response header with the given name.This method considers only response headers set or added via
HttpServletResponse.setHeader(java.lang.String, java.lang.String),HttpServletResponse.addHeader(java.lang.String, java.lang.String),HttpServletResponse.setDateHeader(java.lang.String, long),HttpServletResponse.addDateHeader(java.lang.String, long),HttpServletResponse.setIntHeader(java.lang.String, int), orHttpServletResponse.addIntHeader(java.lang.String, int), respectively.Any changes to the returned
Collectionmust not affect thisHttpServletResponse.- Specified by:
getHeadersin interfaceHttpServletResponse- Parameters:
string- the name of the response header whose values to return- Returns:
- a (possibly empty)
Collectionof the values of the response header with the given name
-
setDateHeader
Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. ThecontainsHeadermethod can be used to test for the presence of a header before setting its value.- Specified by:
setDateHeaderin interfaceHttpServletResponse- Parameters:
name- the name of the header to setdate- the assigned date value- See Also:
-
addDateHeader
Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.- Specified by:
addDateHeaderin interfaceHttpServletResponse- Parameters:
name- the name of the header to setdate- the additional date value- See Also:
-
setHeader
Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeadermethod can be used to test for the presence of a header before setting its value.- Specified by:
setHeaderin interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)- See Also:
-
addHeader
Adds a response header with the given name and value. This method allows response headers to have multiple values.- Specified by:
addHeaderin interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)- See Also:
-
setIntHeader
Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeadermethod can be used to test for the presence of a header before setting its value.- Specified by:
setIntHeaderin interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- the assigned integer value- See Also:
-
addIntHeader
Adds a response header with the given name and integer value. This method allows response headers to have multiple values.- Specified by:
addIntHeaderin interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- the assigned integer value- See Also:
-
setStatus
public void setStatus(int sc) Sets the status code for this response.This method is used to set the return status code when there is no error (for example, for the SC_OK or SC_MOVED_TEMPORARILY status codes).
If this method is used to set an error code, then the container's error page mechanism will not be triggered. If there is an error and the caller wishes to invoke an error page defined in the web application, then
HttpServletResponse.sendError(int, java.lang.String)must be used instead.This method preserves any cookies and other response headers.
Valid status codes are those in the 2XX, 3XX, 4XX, and 5XX ranges. Other status codes are treated as container specific.
- Specified by:
setStatusin interfaceHttpServletResponse- Parameters:
sc- the status code- See Also:
-
getStatus
public int getStatus()Description copied from interface:HttpServletResponseGets the current status code of this response.- Specified by:
getStatusin interfaceHttpServletResponse- Returns:
- the current status code of this response
-
getMessage
-
isError
public boolean isError() -
getContentType
Returns the content type used for the MIME body sent in this response. The content type proper must have been specified usingServletResponse.setContentType(java.lang.String)before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified, and a character encoding has been explicitly or implicitly specified as described inServletResponse.getCharacterEncoding()orServletResponse.getWriter()has been called, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.- Specified by:
getContentTypein interfaceServletResponse- Returns:
- a
Stringspecifying the content type, for example,text/html; charset=UTF-8, or null
-
setCharacterEncoding
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the response character encoding has already been set byServletContext.setResponseCharacterEncoding(java.lang.String), the deployment descriptor, or using theServletResponse.setContentType(java.lang.String)orServletResponse.setLocale(java.util.Locale)methods, the value set in this method overrides all of those values. CallingServletResponse.setContentType(java.lang.String)with theStringoftext/htmland calling this method with theStringofUTF-8is equivalent to callingServletResponse.setContentType(java.lang.String)with theStringoftext/html; charset=UTF-8.This method can be called repeatedly to change the character encoding. This method has no effect if it is called after
getWriterhas been called or after the response has been committed.If calling this method has an effect (as per the previous paragraph), calling this method with
nullclears any character encoding set via a previous call to this method,ServletResponse.setContentType(java.lang.String)orServletResponse.setLocale(java.util.Locale)but does not affect any default character encoding configured viaServletContext.setResponseCharacterEncoding(java.lang.String)or the deployment descriptor.If this method is called with an invalid or unrecognised character encoding, then a subsequent call to
ServletResponse.getWriter()will throw aUnsupportedEncodingException. Content for an unknown encoding can be sent with theServletOutputStreamreturned fromServletResponse.getOutputStream().Containers may choose to log calls to this method that use an invalid or unrecognised character encoding.
Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the
Content-Typeheader for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.- Specified by:
setCharacterEncodingin interfaceServletResponse- Parameters:
charEnc- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) ornull- See Also:
-
getResponse
-
getInternalResponse
Returns internal GrizzlyResponseassociated with this Holder.- Specified by:
getInternalResponsein interfaceHolders.ResponseHolder
-
setTrailerFields
Sets the supplier of trailer headers.The trailer header field value is defined as a comma-separated list (see Section 3.2.2 and Section 4.1.2 of RFC 7230).
The supplier will be called within the scope of whatever thread/call causes the response content to be completed. Typically this will be any thread calling close() on the output stream or writer.
The trailers that run afoul of the provisions of section 4.1.2 of RFC 7230 are ignored.
The RFC requires the name of every key that is to be in the supplied Map is included in the comma separated list that is the value of the "Trailer" response header. The application is responsible for ensuring this requirement is met. Failure to do so may lead to interoperability failures.
- Specified by:
setTrailerFieldsin interfaceHttpServletResponse- Parameters:
supplier- the supplier of trailer headers
-
getTrailerFields
Gets the supplier of trailer headers.- Specified by:
getTrailerFieldsin interfaceHttpServletResponse- Returns:
Supplierof trailer headers
-