Module jakarta.servlet

Package jakarta.servlet.http

Class NoBodyResponse

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

jakarta.servlet.http.NoBodyResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

@Deprecated(forRemoval=true,
            since="Servlet 6.0")
class NoBodyResponse
extends HttpServletResponseWrapper

Deprecated, for removal: This API element is subject to removal in a future version.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	didSetContentLength	Deprecated, for removal: This API element is subject to removal in a future version.
private static final ResourceBundle	lStrings	Deprecated, for removal: This API element is subject to removal in a future version.
private NoBodyOutputStream	noBody	Deprecated, for removal: This API element is subject to removal in a future version.
private boolean	usingOutputStream	Deprecated, for removal: This API element is subject to removal in a future version.
private PrintWriter	writer	Deprecated, for removal: This API element is subject to removal in a future version.

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
NoBodyResponse(HttpServletResponse r)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
void	addIntHeader(String name, int value)	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
private void	checkHeader(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
ServletOutputStream	getOutputStream()	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to return getOutputStream() on the wrapped response object.
PrintWriter	getWriter()	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to return getWriter() on the wrapped response object.
void	reset()	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to call reset() on the wrapped response object.
void	resetBuffer()	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to call resetBuffer() on the wrapped response object.
(package private) void	setContentLength()	Deprecated, for removal: This API element is subject to removal in a future version.
void	setContentLength(int len)	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
void	setContentLengthLong(long len)	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
void	setHeader(String name, String value)	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
void	setIntHeader(String name, int value)	Deprecated, for removal: This API element is subject to removal in a future version. The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setStatus, setTrailerFields

Methods inherited from class jakarta.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, setBufferSize, setCharacterEncoding, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, setBufferSize, setCharacterEncoding, setContentType, setLocale

Field Details

lStrings

private static final ResourceBundle lStrings

Deprecated, for removal: This API element is subject to removal in a future version.

noBody

private NoBodyOutputStream noBody

Deprecated, for removal: This API element is subject to removal in a future version.

writer

private PrintWriter writer

Deprecated, for removal: This API element is subject to removal in a future version.

didSetContentLength

private boolean didSetContentLength

Deprecated, for removal: This API element is subject to removal in a future version.

usingOutputStream

private boolean usingOutputStream

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

NoBodyResponse

NoBodyResponse(HttpServletResponse r)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

setContentLength

void setContentLength()

Deprecated, for removal: This API element is subject to removal in a future version.

setContentLength

public void setContentLength(int len)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setContentLength(int len) on the wrapped response object.

Specified by:

setContentLength in interface ServletResponse

Overrides:

setContentLength in class ServletResponseWrapper

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)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.

Specified by:

setContentLengthLong in interface ServletResponse

Overrides:

setContentLengthLong in class ServletResponseWrapper

Parameters:

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

setHeader

public void setHeader(String name,
 String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.

Specified by:

setHeader in interface HttpServletResponse

Overrides:

setHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

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

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.

Specified by:

addHeader in interface HttpServletResponse

Overrides:

addHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - 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 name,
 int value)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.

Specified by:

setIntHeader in interface HttpServletResponse

Overrides:

setIntHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the assigned integer value

See Also:

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

addIntHeader

public void addIntHeader(String name,
 int value)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.

Specified by:

addIntHeader in interface HttpServletResponse

Overrides:

addIntHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the assigned integer value

See Also:

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

checkHeader

private void checkHeader(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

reset

public void reset()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call reset() on the wrapped response object.

Specified by:

reset in interface ServletResponse

Overrides:

reset in class ServletResponseWrapper

See Also:

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

resetBuffer

public void resetBuffer()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call resetBuffer() on the wrapped response object.

Specified by:

resetBuffer in interface ServletResponse

Overrides:

resetBuffer in class ServletResponseWrapper

See Also:

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

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: ServletResponseWrapper

The default behavior of this method is to return getOutputStream() on the wrapped response object.

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Returns:

a ServletOutputStream for writing binary data

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getWriter()
• ServletResponse.reset()

getWriter

public PrintWriter getWriter()
                      throws UnsupportedEncodingException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: ServletResponseWrapper

The default behavior of this method is to return getWriter() on the wrapped response object.

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Returns:

a PrintWriter object that can return character data to the client

Throws:

UnsupportedEncodingException - if the character encoding returned by getCharacterEncoding cannot be used

See Also:

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