Package org.apache.jackrabbit.webdav

Class WebdavResponseImpl

java.lang.Object

org.apache.jackrabbit.webdav.WebdavResponseImpl

All Implemented Interfaces:

HttpServletResponse, ServletResponse, DavServletResponse, ObservationDavServletResponse, WebdavResponse

public class WebdavResponseImpl
extends Object
implements WebdavResponse

WebdavResponseImpl implements the WebdavResponse interface.

Field Summary

Fields inherited from interface org.apache.jackrabbit.webdav.DavServletResponse

SC_FAILED_DEPENDENCY, SC_INSUFFICIENT_SPACE_ON_RESOURCE, SC_LOCKED, SC_MULTI_STATUS, SC_PROCESSING, SC_UNPROCESSABLE_ENTITY

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
WebdavResponseImpl(HttpServletResponse httpResponse)	Create a new WebdavResponse
WebdavResponseImpl(HttpServletResponse httpResponse, boolean noCache)	Create a new WebdavResponse

Method Summary

Modifier and Type	Method	Description
void	addCookie(Cookie cookie)	Adds the specified cookie to the response.
void	addDateHeader(String s, long l)	Adds a response header with the given name and date-value.
void	addHeader(String s, String s1)	Adds a response header with the given name and value.
void	addIntHeader(String s, int i)	Adds a response header with the given name and integer value.
boolean	containsHeader(String s)	Returns a boolean indicating whether the named response header has already been set.
String	encodeRedirectUrl(String s)
String	encodeRedirectURL(String s)	Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.
String	encodeUrl(String s)
String	encodeURL(String s)	Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
void	flushBuffer()	Forces any content in the buffer to be written to the client.
int	getBufferSize()	Returns the actual buffer size used for the response.
String	getCharacterEncoding()	Returns the name of the character encoding (MIME charset) used for the body sent in this response.
String	getContentType()	Returns the content type used for the MIME body sent in this response.
String	getHeader(String name)	Return the value for the specified header, or null if this header has not been set.
Collection<String>	getHeaderNames()	Get the header names set for this HTTP response.
Collection<String>	getHeaders(String name)	Return a Collection of all the header values associated with the specified header name.
Locale	getLocale()	Returns the locale specified for this response using the ServletResponse.setLocale(java.util.Locale) method.
ServletOutputStream	getOutputStream()	Returns a ServletOutputStream suitable for writing binary data in the response.
int	getStatus()	Get the HTTP status code for this Response.
Supplier<Map<String,String>>	getTrailerFields()
PrintWriter	getWriter()	Returns a PrintWriter object that can send character text to the client.
boolean	isCommitted()	Returns a boolean indicating if the response has been committed.
void	reset()	Clears any data that exists in the buffer as well as the status code and headers.
void	resetBuffer()	Clears the content of the underlying buffer in the response without clearing headers or status code.
void	sendError(int i)	Sends an error response to the client using the specified status code and clears the buffer.
void	sendError(int i, String s)	Sends an error response to the client using the specified status code and clears the output buffer.
void	sendError(DavException exception)	If the specifid exception provides an error condition an Xml response body is sent providing more detailed information about the error.
void	sendMultiStatus(MultiStatus multistatus)	Send the multistatus response to the client.
void	sendMultiStatus(MultiStatus multistatus, List<String> acceptableContentCodings)	Send the multistatus response to the client.
void	sendPollResponse(EventDiscovery eventDiscovery)	Send the response to a successful POLL request.
void	sendRedirect(String s)	Sends a temporary redirect response to the client using the specified redirect location URL.
void	sendRefreshLockResponse(ActiveLock[] locks)	Send response body for a lock request that was intended to refresh one or several locks.
void	sendSubscriptionResponse(Subscription subscription)	Send the response to a successful SUBSCRIBE request.
void	sendXmlResponse(XmlSerializable serializable, int status)	Generic method to return an Xml response body.
void	sendXmlResponse(XmlSerializable serializable, int status, List<String> acceptableContentCodings)	Generic method to return an Xml response body.
void	setBufferSize(int i)	Sets the preferred buffer size for the body of the response.
void	setCharacterEncoding(String charset)	Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
void	setContentLength(int i)	Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
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.
void	setContentType(String s)	Sets the content type of the response being sent to the client, if the response has not been committed yet.
void	setDateHeader(String s, long l)	Sets a response header with the given name and date-value.
void	setHeader(String s, String s1)	Sets a response header with the given name and value.
void	setIntHeader(String s, int i)	Sets a response header with the given name and integer value.
void	setLocale(Locale locale)	Sets the locale of the response, if the response has not been committed yet.
void	setStatus(int i)	Sets the status code for this response.
void	setStatus(int i, String s)	Sets the status code and message for this response.
void	setTrailerFields(Supplier<Map<String,String>> supplier)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebdavResponseImpl

public WebdavResponseImpl(HttpServletResponse httpResponse)

Create a new WebdavResponse

Parameters:

httpResponse -

WebdavResponseImpl

public WebdavResponseImpl(HttpServletResponse httpResponse,
 boolean noCache)

Create a new WebdavResponse

Parameters:

httpResponse -

noCache -

Method Details

sendError

public void sendError(DavException exception)
               throws IOException

If the specifid exception provides an error condition an Xml response body is sent providing more detailed information about the error. Otherwise only the error code and status phrase is sent back.

Specified by:

sendError in interface DavServletResponse

Parameters:

exception -

Throws:

IOException

See Also:

• DavServletResponse.sendError(org.apache.jackrabbit.webdav.DavException)
• sendError(int, String)
• sendXmlResponse(XmlSerializable, int)

sendMultiStatus

public void sendMultiStatus(MultiStatus multistatus)
                     throws IOException

Description copied from interface: DavServletResponse

Send the multistatus response to the client. A multistatus response is returned in response to a successful PROPFIND and PROPPATCH request. In addition multistatus response is required response in case a COPY, MOVE, DELETE, LOCK or PROPPATCH request fails.

Specified by:

sendMultiStatus in interface DavServletResponse

Parameters:

multistatus -

Throws:

IOException

See Also:

• DavServletResponse.SC_MULTI_STATUS

sendMultiStatus

public void sendMultiStatus(MultiStatus multistatus,
 List<String> acceptableContentCodings)
                     throws IOException

Description copied from interface: DavServletResponse

Send the multistatus response to the client. A multistatus response is returned in response to a successful PROPFIND and PROPPATCH request. In addition multistatus response is required response in case a COPY, MOVE, DELETE, LOCK or PROPPATCH request fails.

Specified by:

sendMultiStatus in interface DavServletResponse

Parameters:

multistatus -

acceptableContentCodings - content codings accepted by the client

Throws:

IOException

See Also:

• DavServletResponse.SC_MULTI_STATUS

sendRefreshLockResponse

public void sendRefreshLockResponse(ActiveLock[] locks)
                             throws IOException

Send response body for a lock request that was intended to refresh one or several locks.

Specified by:

sendRefreshLockResponse in interface DavServletResponse

Parameters:

locks -

Throws:

IOException

See Also:

• DavServletResponse.sendRefreshLockResponse(org.apache.jackrabbit.webdav.lock.ActiveLock[])

sendXmlResponse

public void sendXmlResponse(XmlSerializable serializable,
 int status)
                     throws IOException

Description copied from interface: DavServletResponse

Generic method to return an Xml response body.

Specified by:

sendXmlResponse in interface DavServletResponse

Parameters:

serializable - object that can be converted to the root Xml element of the document to be sent as response body.

status - Status code to be used with HttpServletResponse.setStatus(int).

Throws:

IOException

sendXmlResponse

public void sendXmlResponse(XmlSerializable serializable,
 int status,
 List<String> acceptableContentCodings)
                     throws IOException

Description copied from interface: DavServletResponse

Generic method to return an Xml response body.

Specified by:

sendXmlResponse in interface DavServletResponse

Parameters:

serializable - object that can be converted to the root Xml element of the document to be sent as response body.

status - Status code to be used with HttpServletResponse.setStatus(int).

acceptableContentCodings - content codings accepted by the client

Throws:

IOException

sendSubscriptionResponse

public void sendSubscriptionResponse(Subscription subscription)
                              throws IOException

Description copied from interface: ObservationDavServletResponse

Send the response to a successful SUBSCRIBE request.

Specified by:

sendSubscriptionResponse in interface ObservationDavServletResponse

Parameters:

subscription -

Throws:

IOException

See Also:

• ObservationDavServletResponse.sendSubscriptionResponse(org.apache.jackrabbit.webdav.observation.Subscription)

sendPollResponse

public void sendPollResponse(EventDiscovery eventDiscovery)
                      throws IOException

Description copied from interface: ObservationDavServletResponse

Send the response to a successful POLL request.

Specified by:

sendPollResponse in interface ObservationDavServletResponse

Parameters:

eventDiscovery -

Throws:

IOException

See Also:

• ObservationDavServletResponse.sendPollResponse(org.apache.jackrabbit.webdav.observation.EventDiscovery)

addCookie

public void addCookie(Cookie cookie)

Description copied from interface: HttpServletResponse

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

Specified by:

addCookie in interface HttpServletResponse

Parameters:

cookie - the Cookie to return to the client

containsHeader

public boolean containsHeader(String s)

Description copied from interface: HttpServletResponse

Returns a boolean indicating whether the named response header has already been set.

Specified by:

containsHeader in interface HttpServletResponse

Parameters:

s - the header name

Returns:

true if the named response header has already been set; false otherwise

encodeURL

public String encodeURL(String s)

Description copied from interface: HttpServletResponse

Encodes the specified URL by including the session ID in it, 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.

Specified by:

encodeURL in interface HttpServletResponse

Parameters:

s - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

encodeRedirectURL

public String encodeRedirectURL(String s)

Description copied from interface: HttpServletResponse

Encodes the specified URL for use in the sendRedirect method 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. 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 the encodeURL method.

All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Specified by:

encodeRedirectURL in interface HttpServletResponse

Parameters:

s - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

See Also:

• HttpServletResponse.sendRedirect(java.lang.String)
• HttpServletResponse.encodeUrl(java.lang.String)

encodeUrl

public String encodeUrl(String s)

Specified by:

encodeUrl in interface HttpServletResponse

Parameters:

s - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

encodeRedirectUrl

public String encodeRedirectUrl(String s)

Specified by:

encodeRedirectUrl in interface HttpServletResponse

Parameters:

s - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

sendError

public void sendError(int i,
 String s)
               throws IOException

Description copied from interface: HttpServletResponse

Sends an error response to the client using the specified status code and clears the output 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", leaving cookies and other headers unmodified. 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.

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:

sendError in interface HttpServletResponse

Parameters:

i - the error status code

s - the descriptive message

Throws:

IOException - If an input or output exception occurs

sendError

public void sendError(int i)
               throws IOException

Description copied from interface: HttpServletResponse

Sends an error response to the client using the specified status code and clears the buffer. This is equivalent to calling HttpServletResponse.sendError(int, String) with the same status code and null for the message.

Specified by:

sendError in interface HttpServletResponse

Parameters:

i - the error status code

Throws:

IOException - If an input or output exception occurs

sendRedirect

public void sendRedirect(String s)
                  throws IOException

Description copied from interface: HttpServletResponse

Sends a temporary redirect response to the client using the specified redirect location URL. 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 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:

sendRedirect in interface HttpServletResponse

Parameters:

s - the redirect location URL

Throws:

IOException - If an input or output exception occurs

setDateHeader

public void setDateHeader(String s,
 long l)

Description copied from interface: HttpServletResponse

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. The containsHeader method can be used to test for the presence of a header before setting its value.

Specified by:

setDateHeader in interface HttpServletResponse

Parameters:

s - the name of the header to set

l - the assigned date value

See Also:

• HttpServletResponse.containsHeader(java.lang.String)
• HttpServletResponse.addDateHeader(java.lang.String, long)

addDateHeader

public void addDateHeader(String s,
 long l)

Description copied from interface: HttpServletResponse

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:

addDateHeader in interface HttpServletResponse

Parameters:

s - the name of the header to set

l - the additional date value

See Also:

• HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String s,
 String s1)

Description copied from interface: HttpServletResponse

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Specified by:

setHeader in interface HttpServletResponse

Parameters:

s - the name of the header

s1 - 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:

• HttpServletResponse.containsHeader(java.lang.String)
• HttpServletResponse.addHeader(java.lang.String, java.lang.String)

addHeader

public void addHeader(String s,
 String s1)

Description copied from interface: HttpServletResponse

Adds a response header with the given name and value. This method allows response headers to have multiple values.

Specified by:

addHeader in interface HttpServletResponse

Parameters:

s - the name of the header

s1 - 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:

• HttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(String s,
 int i)

Description copied from interface: HttpServletResponse

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. The containsHeader method can be used to test for the presence of a header before setting its value.

Specified by:

setIntHeader in interface HttpServletResponse

Parameters:

s - the name of the header

i - the assigned integer value

See Also:

• HttpServletResponse.containsHeader(java.lang.String)
• HttpServletResponse.addIntHeader(java.lang.String, int)

addIntHeader

public void addIntHeader(String s,
 int i)

Description copied from interface: HttpServletResponse

Adds a response header with the given name and integer value. This method allows response headers to have multiple values.

Specified by:

addIntHeader in interface HttpServletResponse

Parameters:

s - the name of the header

i - the assigned integer value

See Also:

• HttpServletResponse.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int i)

Description copied from interface: HttpServletResponse

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 status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.

The container clears the buffer and sets the Location header, preserving cookies and other headers.

Specified by:

setStatus in interface HttpServletResponse

Parameters:

i - the status code

See Also:

• HttpServletResponse.sendError(int, java.lang.String)

setStatus

public void setStatus(int i,
 String s)

Description copied from interface: HttpServletResponse

Sets the status code and message for this response.

Specified by:

setStatus in interface HttpServletResponse

Parameters:

i - the status code

s - the status message

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: ServletResponse

Returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using the ServletResponse.setCharacterEncoding(java.lang.String) or ServletResponse.setContentType(java.lang.String) methods, or implicitly using the ServletResponse.setLocale(java.util.Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after getWriter has 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-1 is returned.

See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.

Specified by:

getCharacterEncoding in interface ServletResponse

Returns:

a String specifying the name of the character encoding, for example, UTF-8

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Description copied from interface: ServletResponse

Returns a ServletOutputStream suitable 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.

Specified by:

getOutputStream in interface ServletResponse

Returns:

a ServletOutputStream for writing binary data

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getWriter()

getWriter

public PrintWriter getWriter()
                      throws IOException

Description copied from interface: ServletResponse

Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding returned by ServletResponse.getCharacterEncoding(). If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

Calling flush() on the PrintWriter commits the response.

Either this method or ServletResponse.getOutputStream() may be called to write the body, not both.

Specified by:

getWriter in interface ServletResponse

Returns:

a PrintWriter object that can return character data to the client

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getOutputStream()
• ServletResponse.setCharacterEncoding(java.lang.String)

setContentLength

public void setContentLength(int i)

Description copied from interface: ServletResponse

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Specified by:

setContentLength in interface ServletResponse

Parameters:

i - an integer specifying the length of the content being returned to the client; sets the Content-Length header

setContentType

public void setContentType(String s)

Description copied from interface: ServletResponse

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 before 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 getWriter has been called or after the response has been committed.

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-Type header is used.

Specified by:

setContentType in interface ServletResponse

Parameters:

s - a String specifying the MIME type of the content

See Also:

• ServletResponse.setLocale(java.util.Locale)
• ServletResponse.setCharacterEncoding(java.lang.String)
• ServletResponse.getOutputStream()
• ServletResponse.getWriter()

setBufferSize

public void setBufferSize(int i)

Description copied from interface: ServletResponse

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 using getBufferSize.

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:

setBufferSize in interface ServletResponse

Parameters:

i - the preferred buffer size

See Also:

• ServletResponse.getBufferSize()
• ServletResponse.flushBuffer()
• ServletResponse.isCommitted()
• ServletResponse.reset()

getBufferSize

public int getBufferSize()

Description copied from interface: ServletResponse

Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.

Specified by:

getBufferSize in interface ServletResponse

Returns:

the actual buffer size used

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.flushBuffer()
• ServletResponse.isCommitted()
• ServletResponse.reset()

flushBuffer

public void flushBuffer()
                 throws IOException

Description copied from interface: ServletResponse

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:

flushBuffer in interface ServletResponse

Throws:

IOException - if an I/O occurs during the flushing of the response

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.getBufferSize()
• ServletResponse.isCommitted()
• ServletResponse.reset()

resetBuffer

public void resetBuffer()

Description copied from interface: ServletResponse

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 an IllegalStateException.

Specified by:

resetBuffer in interface ServletResponse

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.getBufferSize()
• ServletResponse.isCommitted()
• ServletResponse.reset()

isCommitted

public boolean isCommitted()

Description copied from interface: ServletResponse

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Specified by:

isCommitted in interface ServletResponse

Returns:

a boolean indicating if the response has been committed

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.getBufferSize()
• ServletResponse.flushBuffer()
• ServletResponse.reset()

reset

public void reset()

Description copied from interface: ServletResponse

Clears any data that exists in the buffer as well as the status code and headers. If the response has been committed, this method throws an IllegalStateException.

Specified by:

reset in interface ServletResponse

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.getBufferSize()
• ServletResponse.flushBuffer()
• ServletResponse.isCommitted()

setLocale

public void setLocale(Locale locale)

Description copied from interface: ServletResponse

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 using ServletResponse.setContentType(java.lang.String) or ServletResponse.setCharacterEncoding(java.lang.String), getWriter hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains a locale-encoding-mapping-list element, 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, after ServletResponse.setCharacterEncoding(java.lang.String) has been called, after getWriter has been called, or after the response has been committed.

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-Language header, the character encoding as part of the Content-Type header 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:

setLocale in interface ServletResponse

Parameters:

locale - the locale of the response

See Also:

• ServletResponse.getLocale()
• ServletResponse.setContentType(java.lang.String)
• ServletResponse.setCharacterEncoding(java.lang.String)

getLocale

public Locale getLocale()

Description copied from interface: ServletResponse

Returns the locale specified for this response using the ServletResponse.setLocale(java.util.Locale) method. Calls made to setLocale after the response is committed have no effect.

Specified by:

getLocale in interface ServletResponse

Returns:

The locale specified for this response using the ServletResponse.setLocale(java.util.Locale) method. If no locale has been specified, the container's default locale is returned.

See Also:

• ServletResponse.setLocale(java.util.Locale)

getContentType

public String getContentType()

Description copied from interface: ServletResponse

Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using ServletResponse.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 in ServletResponse.getCharacterEncoding(), the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.

Specified by:

getContentType in interface ServletResponse

Returns:

a String specifying the content type, for example, text/html; charset=UTF-8, or null

setCharacterEncoding

public void setCharacterEncoding(String charset)

Description copied from interface: ServletResponse

Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by ServletResponse.setContentType(java.lang.String) or ServletResponse.setLocale(java.util.Locale), this method overrides it. Calling ServletResponse.setContentType(java.lang.String) with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/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 getWriter has been called or after the response has been committed.

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-Type header 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:

setCharacterEncoding in interface ServletResponse

Parameters:

charset - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)

See Also:

• #setLocale

getStatus

public int getStatus()

Description copied from interface: HttpServletResponse

Get the HTTP status code for this Response.

Specified by:

getStatus in interface HttpServletResponse

Returns:

The HTTP status code for this Response

getHeader

public String getHeader(String name)

Description copied from interface: HttpServletResponse

Return the value for the specified header, or null if this header has not been set. If more than one value was added for this name, only the first is returned; use HttpServletResponse.getHeaders(String) to retrieve all of them.

Specified by:

getHeader in interface HttpServletResponse

Parameters:

name - Header name to look up

Returns:

The first value for the specified header. This is the raw value so if multiple values are specified in the first header then they will be returned as a single header value .

getHeaders

public Collection<String> getHeaders(String name)

Description copied from interface: HttpServletResponse

Return a Collection of all the header values associated with the specified header name.

Specified by:

getHeaders in interface HttpServletResponse

Parameters:

name - Header name to look up

Returns:

The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.

getHeaderNames

public Collection<String> getHeaderNames()

Description copied from interface: HttpServletResponse

Get the header names set for this HTTP response.

Specified by:

getHeaderNames in interface HttpServletResponse

Returns:

The header names set for this HTTP response.

setContentLengthLong

public void setContentLengthLong(long len)

Description copied from interface: ServletResponse

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Specified by:

setContentLengthLong in interface ServletResponse

Parameters:

len - an integer specifying the length of the content being returned to the client; sets the Content-Length header

setTrailerFields

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

Specified by:

setTrailerFields in interface WebdavResponse

getTrailerFields

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

Specified by:

getTrailerFields in interface WebdavResponse