Modifier and Type	Class and Description
protected static enum	ServletContextResponse.EncodingFrom
private class	ServletContextResponse.HttpFieldsWrapper Wrapper of the response HttpFields to allow specific values to be intercepted.
protected static enum	ServletContextResponse.OutputType

Modifier and Type	Field and Description
private String	_characterEncoding
private long	_contentLength
private String	_contentType
private ServletContextResponse.EncodingFrom	_encodingFrom
private final HttpFields.Mutable.Wrapper	_headers
private Locale	_locale
private MimeTypes.Type	_mimeType
private ServletContextResponse.OutputType	_outputType
private final ServletApiResponse	_servletApiResponse
private final ServletChannel	_servletChannel
private Supplier<Map<String, String>>	_trailers
private ResponseWriter	_writer
private long	_written

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

Modifier and Type	Method and Description
public void	closeOutput()
public void	completeOutput(Callback callback)
public String	getCharacterEncoding() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getCharacterEncoding.
public String	getCharacterEncoding(boolean setContentType) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getCharacterEncoding.
pack-priv long	Returns: the number of bytes written via this class `write(boolean, ByteBuffer, Callback)` method. getContentBytesWritten() Returns the number of bytes written via this class `write(boolean, ByteBuffer, Callback)` method.
public long	getContentLength()
public String	getContentType() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getContentType.
public ServletContextResponse.EncodingFrom	getEncodingFrom() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getEncodingFrom.
public HttpFields.Mutable	getHeaders() Overrides org.eclipse.jetty.server.Response.Wrapper.getHeaders. Implements org.eclipse.jetty.server.Response.getHeaders.
public HttpOutput	getHttpOutput()
public Locale	getLocale() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getLocale.
protected MimeTypes.Type	getMimeType()
public ServletContextResponse.OutputType	getOutputType() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getOutputType.
public String	Returns: the raw character encoding getRawCharacterEncoding() Get the raw value of the Character Encoding field.
public Response	getResponse() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getResponse.
public ServletApiResponse	getServletApiResponse()
protected ServletContextRequest	getServletContextRequest()
public static ServletContextResponse	getServletContextResponse(ServletResponse response)
public ServletChannelState	getServletRequestState()
public Supplier<Map<String, String>>	getTrailers() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getTrailers.
public ResponseWriter	getWriter() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getWriter.
public void	included()
public boolean	isAllContentWritten(long written)
public boolean	isContentIncomplete(long written)
public boolean	isStreaming()
public boolean	isWriting() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.isWriting.
public boolean	isWritingOrStreaming()
protected ServletApiResponse	newServletApiResponse()
public void	reset() Overrides org.eclipse.jetty.server.Response.Wrapper.reset. Implements org.eclipse.jetty.server.Response.reset. Resets this response, clearing the HTTP status code, HTTP headers and HTTP trailers.
public void	resetContent()
public void	resetForForward()
public void	setCharacterEncoding(String the character encoding encoding, ServletContextResponse.EncodingFrom where encoding came from from) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setCharacterEncoding. Update the Content-Type, MimeType, and headers from the provided Character Encoding and EncodingFrom.
public void	setContentLength(int len)
public void	setContentLength(long len)
public void	setLocale(Locale locale) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setLocale.
public void	setOutputType(ServletContextResponse.OutputType outputType) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setOutputType.
public void	setTrailers(Supplier<Map<String, String>> trailers) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setTrailers.
public void	setWriter(ResponseWriter writer) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setWriter.
public void	write(boolean whether the ByteBuffer is the last to write last, ByteBuffer the ByteBuffer to write content, Callback the callback to notify when the write operation is complete callback) Overrides org.eclipse.jetty.server.handler.ContextResponse.write. Implements org.eclipse.jetty.server.Response.write. Writes the given `ByteBuffer`, notifying the `Callback` when the write is complete.

_characterEncoding	back to summary
private String _characterEncoding

_contentLength	back to summary
private long _contentLength

_contentType	back to summary
private String _contentType

_encodingFrom	back to summary
private ServletContextResponse.EncodingFrom _encodingFrom

_headers	back to summary
private final HttpFields.Mutable.Wrapper _headers

_locale	back to summary
private Locale _locale

_mimeType	back to summary
private MimeTypes.Type _mimeType

_outputType	back to summary
private ServletContextResponse.OutputType _outputType

_servletApiResponse	back to summary
private final ServletApiResponse _servletApiResponse

_servletChannel	back to summary
private final ServletChannel _servletChannel

_trailers	back to summary
private Supplier<Map<String, String>> _trailers

_writer	back to summary
private ResponseWriter _writer

_written	back to summary
private long _written

ServletContextResponse	back to summary
public ServletContextResponse(ServletChannel servletChannel, ServletContextRequest request, Response response)

Method Detail

closeOutput	back to summary
public void closeOutput() throws IOException

completeOutput	back to summary
public void completeOutput(Callback callback)

getCharacterEncoding	back to summary
public String getCharacterEncoding() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getCharacterEncoding. Annotations @Override

getCharacterEncoding

back to summary

public String getCharacterEncoding()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getCharacterEncoding.

Annotations

@Override

getCharacterEncoding	back to summary
public String getCharacterEncoding(boolean setContentType) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getCharacterEncoding. Annotations @Override

getCharacterEncoding

back to summary

public String getCharacterEncoding(boolean setContentType)

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getCharacterEncoding.

Annotations

@Override

getContentBytesWritten back to summary

getContentBytesWritten	back to summary
pack-priv long getContentBytesWritten() Returns the number of bytes written via this class `write(boolean, ByteBuffer, Callback)` method. The number of bytes written to the network may be different. Returns:long the number of bytes written via this class `write(boolean, ByteBuffer, Callback)` method.

pack-priv long getContentBytesWritten()

Returns the number of bytes written via this class write(boolean, ByteBuffer, Callback) method.

The number of bytes written to the network may be different.

Returns:long: the number of bytes written via this class write(boolean, ByteBuffer, Callback) method.

getContentLength	back to summary
public long getContentLength()

getContentType	back to summary
public String getContentType() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getContentType. Annotations @Override

getContentType

back to summary

public String getContentType()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getContentType.

Annotations

@Override

getEncodingFrom	back to summary
public ServletContextResponse.EncodingFrom getEncodingFrom() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getEncodingFrom. Annotations @Override

getEncodingFrom

back to summary

public ServletContextResponse.EncodingFrom getEncodingFrom()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getEncodingFrom.

Annotations

@Override

getHeaders	back to summary
public HttpFields.Mutable getHeaders() Overrides org.eclipse.jetty.server.Response.Wrapper.getHeaders. Implements org.eclipse.jetty.server.Response.getHeaders. Returns:HttpFields.Mutable Doc from org.eclipse.jetty.server.Response.getHeaders. the response HTTP headers Annotations @Override

getHeaders

back to summary

public HttpFields.Mutable getHeaders()

Overrides org.eclipse.jetty.server.Response.Wrapper.getHeaders.

Implements org.eclipse.jetty.server.Response.getHeaders.

Returns:HttpFields.Mutable

Doc from org.eclipse.jetty.server.Response.getHeaders.

the response HTTP headers

Annotations

@Override

getHttpOutput	back to summary
public HttpOutput getHttpOutput()

getLocale	back to summary
public Locale getLocale() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getLocale. Annotations @Override

getLocale

back to summary

public Locale getLocale()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getLocale.

Annotations

@Override

getMimeType	back to summary
protected MimeTypes.Type getMimeType()

getOutputType	back to summary
public ServletContextResponse.OutputType getOutputType() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getOutputType. Annotations @Override

getOutputType

back to summary

public ServletContextResponse.OutputType getOutputType()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getOutputType.

Annotations

@Override

getRawCharacterEncoding	back to summary
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:String the raw character encoding

getRawCharacterEncoding

back to summary

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:String: the raw character encoding

getResponse	back to summary
public Response getResponse() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getResponse. Annotations @Override

getResponse

back to summary

public Response getResponse()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getResponse.

Annotations

@Override

getServletApiResponse	back to summary
public ServletApiResponse getServletApiResponse()

getServletContextRequest	back to summary
protected ServletContextRequest getServletContextRequest()

getServletContextResponse	back to summary
public static ServletContextResponse getServletContextResponse(ServletResponse response)

getServletRequestState	back to summary
public ServletChannelState getServletRequestState()

getTrailers	back to summary
public Supplier<Map<String, String>> getTrailers() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getTrailers. Annotations @Override

getTrailers

back to summary

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

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getTrailers.

Annotations

@Override

getWriter	back to summary
public ResponseWriter getWriter() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getWriter. Annotations @Override

getWriter

back to summary

public ResponseWriter getWriter()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.getWriter.

Annotations

@Override

included	back to summary
public void included()

isAllContentWritten	back to summary
public boolean isAllContentWritten(long written)

isContentIncomplete	back to summary
public boolean isContentIncomplete(long written)

isStreaming	back to summary
public boolean isStreaming()

isWriting	back to summary
public boolean isWriting() Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.isWriting. Annotations @Override

isWriting

back to summary

public boolean isWriting()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.isWriting.

Annotations

@Override

isWritingOrStreaming	back to summary
public boolean isWritingOrStreaming()

newServletApiResponse	back to summary
protected ServletApiResponse newServletApiResponse()

reset	back to summary
public void reset() Overrides org.eclipse.jetty.server.Response.Wrapper.reset. Implements org.eclipse.jetty.server.Response.reset. Doc from org.eclipse.jetty.server.Response.reset. Resets this response, clearing the HTTP status code, HTTP headers and HTTP trailers. Annotations @Override

reset

back to summary

public void reset()

Overrides org.eclipse.jetty.server.Response.Wrapper.reset.

Implements org.eclipse.jetty.server.Response.reset.

Doc from org.eclipse.jetty.server.Response.reset.

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

Annotations

@Override

resetContent	back to summary
public void resetContent()

resetForForward	back to summary
public void resetForForward()

setCharacterEncoding	back to summary
public void setCharacterEncoding(String encoding, ServletContextResponse.EncodingFrom from) Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setCharacterEncoding. Update the Content-Type, MimeType, and headers from the provided Character Encoding and EncodingFrom. Parameters encoding:String the character encoding from:ServletContextResponse.EncodingFrom where encoding came from Annotations @Override

setCharacterEncoding

back to summary

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

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setCharacterEncoding.

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

Parameters

encoding:String: the character encoding
from:ServletContextResponse.EncodingFrom: where encoding came from

Annotations

@Override

setContentLength	back to summary
public void setContentLength(int len)

setContentLength	back to summary
public void setContentLength(long len)

setLocale

back to summary

public void setLocale(Locale locale)

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setLocale.

Annotations

@Override

setOutputType

back to summary

public void setOutputType(ServletContextResponse.OutputType outputType)

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setOutputType.

Annotations

@Override

setTrailers

back to summary

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

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setTrailers.

Annotations

@Override

setWriter

back to summary

public void setWriter(ResponseWriter writer)

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletResponseInfo.setWriter.

Annotations

@Override

write back to summary

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

Overrides org.eclipse.jetty.server.handler.ContextResponse.write.

Implements org.eclipse.jetty.server.Response.write.

Doc from org.eclipse.jetty.server.Response.write.

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.

Parameters

last:boolean: whether the ByteBuffer is the last to write
content:ByteBuffer: the ByteBuffer to write
callback:Callback: the callback to notify when the write operation is complete

Annotations

@Override

org.eclipse.jetty.ee10.servlet back to summary

protected final Enum ServletContextResponse.EncodingFrom

Class Inheritance

extends Enum<ServletContextResponse.EncodingFrom>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.servlet.ServletContextResponse.EncodingFrom

Field Summary

Modifier and Type	Field and Description
public static final ServletContextResponse.EncodingFrom	DEFAULT Using the default character encoding from the context otherwise iso-8859-1.
public static final ServletContextResponse.EncodingFrom	INFERRED Character encoding was inferred from the Content-Type and will be added as a parameter to the Content-Type.
public static final ServletContextResponse.EncodingFrom	NOT_SET Character encoding was not set, or the encoding was cleared with `setCharacterEncoding(null)`.
public static final ServletContextResponse.EncodingFrom	SET_CHARACTER_ENCODING The character encoding has been explicitly set using `HttpServletResponse#setCharacterEncoding(String)`.
public static final ServletContextResponse.EncodingFrom	SET_CONTENT_TYPE The character encoding has been explicitly set using the Content-Type charset parameter with `HttpServletResponse#setContentType(String)`.
public static final ServletContextResponse.EncodingFrom	SET_LOCALE The default character encoding of the locale was used after a call to `HttpServletResponse#setLocale(Locale)`.

Constructor Summary

Access	Constructor and Description
private	EncodingFrom()

Method Summary

Modifier and Type	Method and Description
public static ServletContextResponse.EncodingFrom	valueOf(String name)
public static ServletContextResponse.EncodingFrom[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DEFAULT	back to summary
public static final ServletContextResponse.EncodingFrom DEFAULT Using the default character encoding from the context otherwise iso-8859-1.

INFERRED	back to summary
public static final ServletContextResponse.EncodingFrom INFERRED Character encoding was inferred from the Content-Type and will be added as a parameter to the Content-Type.

NOT_SET	back to summary
public static final ServletContextResponse.EncodingFrom NOT_SET Character encoding was not set, or the encoding was cleared with `setCharacterEncoding(null)`.

SET_CHARACTER_ENCODING	back to summary
public static final ServletContextResponse.EncodingFrom SET_CHARACTER_ENCODING The character encoding has been explicitly set using `HttpServletResponse#setCharacterEncoding(String)`.

SET_CONTENT_TYPE	back to summary
public static final ServletContextResponse.EncodingFrom SET_CONTENT_TYPE The character encoding has been explicitly set using the Content-Type charset parameter with `HttpServletResponse#setContentType(String)`.

SET_LOCALE	back to summary
public static final ServletContextResponse.EncodingFrom SET_LOCALE The default character encoding of the locale was used after a call to `HttpServletResponse#setLocale(Locale)`.

Constructor Detail

EncodingFrom	back to summary
private EncodingFrom()

Method Detail

valueOf	back to summary
public static ServletContextResponse.EncodingFrom valueOf(String name)

values	back to summary
public static ServletContextResponse.EncodingFrom[] values()

org.eclipse.jetty.ee10.servlet back to summary

private Class ServletContextResponse.HttpFieldsWrapper

Class Inheritance

extends Wrapper

java.lang.Object
org.eclipse.jetty.http.HttpFields.Mutable.Wrapper
org.eclipse.jetty.ee10.servlet.ServletContextResponse.HttpFieldsWrapper

Wrapper of the response HttpFields to allow specific values to be intercepted.

Constructor Summary

Access	Constructor and Description
public	HttpFieldsWrapper(HttpFields.Mutable fields)

Method Summary

Modifier and Type	Method and Description
public HttpField	onAddField(HttpField The field being added. field) Overrides org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onAddField. Called when a field is added (including as part of a put).
public boolean	onRemoveField(HttpField The field being removed. field) Overrides org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onRemoveField. Called when a field is removed (including as part of a put).
public HttpField	onReplaceField(HttpField oldField, HttpField newField) Overrides org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onReplaceField.
private HttpField	setContentLength(HttpField field)
private HttpField	setContentType(HttpField field)

Inherited from org.eclipse.jetty.http.HttpFields.Mutable.Wrapper:: add clear listIterator put size stream

Constructor Detail

HttpFieldsWrapper	back to summary
public HttpFieldsWrapper(HttpFields.Mutable fields)

Method Detail

onAddField

back to summary

public HttpField onAddField(HttpField field)

Overrides org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onAddField.

Doc from org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onAddField.

Called when a field is added (including as part of a put).

Parameters

field:HttpField: The field being added.

Returns:HttpField

The field to add, or null if the add is to be ignored.

Annotations

@Override

onRemoveField

back to summary

public boolean onRemoveField(HttpField field)

Overrides org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onRemoveField.

Doc from org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onRemoveField.

Called when a field is removed (including as part of a put).

Parameters

field:HttpField: The field being removed.

Returns:boolean

True if the field should be removed, false otherwise.

Annotations

@Override

onReplaceField

back to summary

public HttpField onReplaceField(HttpField oldField, HttpField newField)

Overrides org.eclipse.jetty.http.HttpFields.Mutable.Wrapper.onReplaceField.

Annotations

@Override

setContentLength	back to summary
private HttpField setContentLength(HttpField field)

setContentType	back to summary
private HttpField setContentType(HttpField field)

Modifier and Type	Field and Description
public static final ServletContextResponse.OutputType	NONE
public static final ServletContextResponse.OutputType	STREAM
public static final ServletContextResponse.OutputType	WRITER

public Class ServletContextResponse

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Enum ServletContextResponse.EncodingFrom

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ServletContextResponse.HttpFieldsWrapper

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected final Enum ServletContextResponse.OutputType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public static ServletContextResponse.OutputType	valueOf(String name)
public static ServletContextResponse.OutputType[]	values()