Class ServletContextResponse

java.lang.Object

org.eclipse.jetty.server.Response.Wrapper

org.eclipse.jetty.server.handler.ContextResponse

org.eclipse.jetty.ee10.servlet.ServletContextResponse

All Implemented Interfaces:

ServletContextHandler.ServletResponseInfo, Content.Sink, Response

public class ServletContextResponse
extends ContextResponse
implements ServletContextHandler.ServletResponseInfo

A core response wrapper that carries the servlet related response state, which may be used directly by the associated ServletApiResponse. Non servlet related state, is used indirectly via ServletChannel.getResponse() which may be a wrapper of this response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	ServletContextResponse.EncodingFrom
protected static enum	ServletContextResponse.OutputType

Nested classes/interfaces inherited from interface Response

Response.Wrapper

Constructor Summary

Constructors

Constructor	Description
ServletContextResponse(ServletChannel servletChannel, ServletContextRequest request, Response response)

Method Summary

Modifier and Type	Method	Description
void	closeOutput()
void	completeOutput(Callback callback)
String	getCharacterEncoding()
String	getCharacterEncoding(boolean setContentType)
long	getContentLength()
String	getContentType()
ServletContextResponse.EncodingFrom	getEncodingFrom()
HttpFields.Mutable	getHeaders()
HttpOutput	getHttpOutput()
Locale	getLocale()
protected MimeTypes.Type	getMimeType()
ServletContextResponse.OutputType	getOutputType()
String	getRawCharacterEncoding()	Get the raw value of the Character Encoding field.
Response	getResponse()
ServletApiResponse	getServletApiResponse()
protected ServletContextRequest	getServletContextRequest()
static ServletContextResponse	getServletContextResponse(jakarta.servlet.ServletResponse response)
ServletChannelState	getServletRequestState()
Supplier<Map<String,String>>	getTrailers()
ResponseWriter	getWriter()
void	included()
boolean	isAllContentWritten(long written)
boolean	isContentIncomplete(long written)
boolean	isStreaming()
boolean	isWriting()
boolean	isWritingOrStreaming()
protected ServletApiResponse	newServletApiResponse()
void	reset()	Resets this response, clearing the HTTP status code, HTTP headers and HTTP trailers.
void	resetContent()
void	resetForForward()
void	setCharacterEncoding(String encoding, ServletContextResponse.EncodingFrom from)	Update the Content-Type, MimeType, and headers from the provided Character Encoding and EncodingFrom.
void	setContentLength(int len)
void	setContentLength(long len)
void	setLocale(Locale locale)
void	setOutputType(ServletContextResponse.OutputType outputType)
void	setTrailers(Supplier<Map<String,String>> trailers)
void	setWriter(ResponseWriter writer)
void	write(boolean last, ByteBuffer content, Callback callback)	Writes the given ByteBuffer, notifying the Callback when the write is complete.

Methods inherited from class Response.Wrapper

getRequest, getStatus, getTrailersSupplier, getWrapped, hasLastWrite, isCommitted, isCompletedSuccessfully, setStatus, setTrailersSupplier, writeInterim

Methods inherited from class Object

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

Constructor Details

ServletContextResponse

public ServletContextResponse(ServletChannel servletChannel,
 ServletContextRequest request,
 Response response)

Method Details

getServletContextResponse

public static ServletContextResponse getServletContextResponse(jakarta.servlet.ServletResponse response)

getResponse

public Response getResponse()

Specified by:

getResponse in interface ServletContextHandler.ServletResponseInfo

getWriter

public ResponseWriter getWriter()

Specified by:

getWriter in interface ServletContextHandler.ServletResponseInfo

setWriter

public void setWriter(ResponseWriter writer)

Specified by:

setWriter in interface ServletContextHandler.ServletResponseInfo

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletContextHandler.ServletResponseInfo

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface ServletContextHandler.ServletResponseInfo

getEncodingFrom

public ServletContextResponse.EncodingFrom getEncodingFrom()

Specified by:

getEncodingFrom in interface ServletContextHandler.ServletResponseInfo

getMimeType

protected MimeTypes.Type getMimeType()

getTrailers

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

Specified by:

getTrailers in interface ServletContextHandler.ServletResponseInfo

setTrailers

public void setTrailers(Supplier<Map<String,String>> trailers)

Specified by:

setTrailers in interface ServletContextHandler.ServletResponseInfo

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletContextHandler.ServletResponseInfo

setOutputType

public void setOutputType(ServletContextResponse.OutputType outputType)

Specified by:

setOutputType in interface ServletContextHandler.ServletResponseInfo

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletContextHandler.ServletResponseInfo

getOutputType

public ServletContextResponse.OutputType getOutputType()

Specified by:

getOutputType in interface ServletContextHandler.ServletResponseInfo

getServletContextRequest

protected ServletContextRequest getServletContextRequest()

newServletApiResponse

protected ServletApiResponse newServletApiResponse()

getHttpOutput

public HttpOutput getHttpOutput()

getServletRequestState

public ServletChannelState getServletRequestState()

getServletApiResponse

public ServletApiResponse getServletApiResponse()

resetForForward

public void resetForForward()

included

public void included()

completeOutput

public void completeOutput(Callback callback)

isAllContentWritten

public boolean isAllContentWritten(long written)

isContentIncomplete

public boolean isContentIncomplete(long written)

setContentLength

public void setContentLength(int len)

getHeaders

public HttpFields.Mutable getHeaders()

Specified by:

getHeaders in interface Response

Overrides:

getHeaders in class Response.Wrapper

Returns:

the response HTTP headers

setContentLength

public void setContentLength(long len)

getContentLength

public long getContentLength()

write

public void write(boolean last,
 ByteBuffer content,
 Callback callback)

Description copied from interface: Response

Writes the given ByteBuffer, notifying the Callback when the write is complete.

Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Callback and a call to this method.

The invocation of the passed Callback is serialized with previous calls of this method, so that it is not invoked until any invocation of the callback of a previous call to this method has returned.

Thus a Callback should not block waiting for a callback of a future call to this method.

Specified by:

write in interface Content.Sink

Specified by:

write in interface Response

Overrides:

write in class ContextResponse

Parameters:

last - whether the ByteBuffer is the last to write

content - the ByteBuffer to write

callback - the callback to notify when the write operation is complete

closeOutput

public void closeOutput()
                 throws IOException

Throws:

IOException

reset

public void reset()

Description copied from interface: Response

Resets this response, clearing the HTTP status code, HTTP headers and HTTP trailers.

Specified by:

reset in interface Response

Overrides:

reset in class Response.Wrapper

resetContent

public void resetContent()

getRawCharacterEncoding

public String getRawCharacterEncoding()

Get the raw value of the Character Encoding field.

This is only the value as set, not from any other discovered source (eg: mimetypes, Content-Type, ServletContext, etc)

Returns:

the raw character encoding

getCharacterEncoding

public String getCharacterEncoding(boolean setContentType)

Specified by:

getCharacterEncoding in interface ServletContextHandler.ServletResponseInfo

setCharacterEncoding

public void setCharacterEncoding(String encoding,
 ServletContextResponse.EncodingFrom from)

Update the Content-Type, MimeType, and headers from the provided Character Encoding and EncodingFrom.

Specified by:

setCharacterEncoding in interface ServletContextHandler.ServletResponseInfo

Parameters:

encoding - the character encoding

from - where encoding came from

isWriting

public boolean isWriting()

Specified by:

isWriting in interface ServletContextHandler.ServletResponseInfo

isStreaming

public boolean isStreaming()

isWritingOrStreaming

public boolean isWritingOrStreaming()