org.spincast.plugins.response

Class SpincastResponseRequestContextAddon<R extends IRequestContext<?>>

java.lang.Object

org.spincast.plugins.response.SpincastResponseRequestContextAddon<R>

All Implemented Interfaces:

IResponseRequestContextAddon<R>

public class SpincastResponseRequestContextAddon<R extends IRequestContext<?>>
extends Object
implements IResponseRequestContextAddon<R>

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	IS_RESPONSE_CHARACTERS_BASED_BY_DEFAULT
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SpincastResponseRequestContextAddon(R requestContext, IServer server, IJsonManager jsonManager, IXmlManager xmlManager, ISpincastConfig spincastConfig, ISpincastUtils spincastUtils, IETagFactory etagFactory)

Method Summary

Modifier and Type	Method and Description
IResponseRequestContextAddon<R>	addHeaderValue(String name, String value) Adds a value to a response header.
IResponseRequestContextAddon<R>	addHeaderValues(String name, List<String> values) Adds a list of values to a response header.
void	end() Flushes everything and closes the response.
void	flush() Flushes the current response.
void	flush(boolean end) Flushes the current response.
protected ByteArrayOutputStream	getBuffer()
String	getCharactersCharsetName() The charset to use to convert characters to bytes.
String	getContentType() The current Content-Type sent or to be send.
protected IETagFactory	getEtagFactory()
protected Object	getExchange()
GZIPOutputStream	getGzipBuffer()
GzipOption	getGzipOption() The currently set gzip options.
List<String>	getHeader(String name) The values of a specific response header.
String	getHeaderFirst(String name) The first value of a specific header.
Map<String,List<String>>	getHeaders() The currently set response headers.
protected IJsonManager	getJsonManager()
protected ByteArrayOutputStream	getOut()
protected R	getRequestContext()
protected IServer	getServer()
protected ISpincastConfig	getSpincastConfig()
protected ISpincastUtils	getSpincastUtils()
int	getStatusCode() The current status code sent or to be send.
byte[]	getUnsentBytes() Gets the current unsent bytes (AKA the buffer).
String	getUnsentCharacters() Gets the current unsent characters (AKA the buffer), using the UTF-8 encoding.
String	getUnsentCharacters(String encoding) Gets the current unsent characters (AKA the buffer), using the specified encoding.
protected IXmlManager	getXmlManager()
boolean	isClosed() Is the response closed? If so, nothing more can be sent...
boolean	isHeadersSent() Are the response headers sent? If this is the case, then the headers can't be changed anymore.
protected boolean	isRequestSizeValidated()
protected boolean	isResponseCharactersBased() Try to determine is the response is characters based or not.
protected boolean	isShouldGzip()
void	redirect(String newUrl, boolean permanently) Sets a redirection header.
void	redirect(String newUrl, int specific3xxCode) Sets the redirection headers with a specified 3xx status code.
IResponseRequestContextAddon<R>	removeHeader(String name) Removes an header by its name.
IResponseRequestContextAddon<R>	resetBuffer() Clears the buffer (the unsent buffer, of course).
IResponseRequestContextAddon<R>	resetEverything() Clears the buffer (the unsent buffer, of course), resets the cookies, the headers, the Content-Type and sets the status code back to 200.
protected void	send(byte[] bytes, String contentType, boolean flush)
void	sendBytes(byte[] bytes) Sends some bytes, without flushing.
void	sendBytes(byte[] bytes, String contentType) Sends some bytes using the specified Content-Type, without flushing.
void	sendBytes(byte[] bytes, String contentType, boolean flush) Send some bytes + flush if specified.
void	sendCharacters(String content) Sends a String, using the encoding returned by getCharactersCharsetName, without flushing.
void	sendCharacters(String content, String contentType) Sends a String, using the encoding returned by getCharactersCharsetName and using the specified Content-Type, without flushing.
void	sendCharacters(String content, String contentType, boolean flush) Sends a String, using the encoding returned by getCharactersCharsetName and using the specified Content-Type.
void	sendHtml(String html) Sends a String as text/html, UTF-8 encoded, without flushing.
void	sendHtml(String string, boolean flush) Sends a String as text/html, UTF-8 encoded, and flushes, if specified.
void	sendHtmlParse(String html, Map<String,Object> params) Parses the given String using the ITemplatingEngine and the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.
void	sendHtmlParse(String html, Map<String,Object> params, boolean flush) Parses the given String using the ITemplatingEngine and the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified.
void	sendHtmlTemplate(String templatePath, boolean isClasspathPath, Map<String,Object> params) Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.
void	sendHtmlTemplate(String templatePath, boolean isClasspathPath, Map<String,Object> params, boolean flush) Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified.
void	sendHtmlTemplate(String templatePath, Map<String,Object> params) Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.
void	sendHtmlTemplate(String templatePath, Map<String,Object> params, boolean flush) Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified.
void	sendJson(String jsonString) Sends a Json String using the application/json Content-Type, without flushing.
void	sendJson(String jsonString, boolean flush) Sends a Json String using the application/json Content-Type, and flushes, if specified.
void	sendJsonObj(Object obj) Serializes the object to Json and sends as application/json, without flushing.
void	sendJsonObj(Object obj, boolean flush) Serializes the object to Json, sends as application/json, and flushes, if specified.
void	sendParse(String content, String contentType, Map<String,Object> params) Parses the given String using the ITemplatingEngine and the given parameters, then sends the result using the specified Content-Type, without flushing.
void	sendParse(String content, String contentType, Map<String,Object> params, boolean flush) Parses the given String using the ITemplatingEngine and the given parameters, then sends the result using the specified Content-Type, and flushes, if specified.
void	sendPlainText(String string) Sends a String as text/plain, UTF-8 encoded, without flushing.
void	sendPlainText(String string, boolean flush) Sends a String as text/plain, UTF-8 encoded, and flushes, if specified.
void	sendTemplate(String templatePath, boolean isClasspathPath, String contentType, Map<String,Object> params) Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, without flushing.
void	sendTemplate(String templatePath, boolean isClasspathPath, String contentType, Map<String,Object> params, boolean flush) Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, and flushes, if specified.
void	sendTemplate(String templatePath, String contentType, Map<String,Object> params) Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, without flushing.
void	sendTemplate(String templatePath, String contentType, Map<String,Object> params, boolean flush) Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, and flushes, if specified.
void	sendXml(String xml) Sends some XML using the application/xml Content-Type, without flushing.
void	sendXml(String xml, boolean flush) Sends some XML using the application/xml Content-Type, and flushes, if specified.
void	sendXmlObj(Object obj) Serializes the object to XML and sends as application/xml, without flushing.
void	sendXmlObj(Object obj, boolean flush) Serializes the object to XML, sends as application/xml, and flushes, if specified.
IResponseRequestContextAddon<R>	setCacheSeconds(int cacheSeconds) Adds caching headers.
IResponseRequestContextAddon<R>	setCacheSeconds(int cacheSeconds, boolean isPrivateCache) Adds caching headers for the specified number of seconds.
IResponseRequestContextAddon<R>	setCharactersCharsetName(String charactersCharsetName) Sets the charset to use to convert characters to bytes.
IResponseRequestContextAddon<R>	setContentType(String responseContentType) The Content-Type header to use for the response.
IResponseRequestContextAddon<R>	setGzipOption(GzipOption gzipOption) Enable or disable gzipping of the response.
IResponseRequestContextAddon<R>	setHeader(String name, List<String> values) Set multiple values to a response header.
IResponseRequestContextAddon<R>	setHeader(String name, String value) Set the value to a response header.
protected void	setIsShouldGzip(Boolean isShouldGzip)
protected void	setRequestSizeValidated(boolean requestSizeValidated)
IResponseRequestContextAddon<R>	setStatusCode(int responseStatusCode) Sets the response's status code to use.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

IS_RESPONSE_CHARACTERS_BASED_BY_DEFAULT

protected static final boolean IS_RESPONSE_CHARACTERS_BASED_BY_DEFAULT

See Also:

Constant Field Values

Constructor Detail

SpincastResponseRequestContextAddon

@Inject
public SpincastResponseRequestContextAddon(R requestContext,
                                                    IServer server,
                                                    IJsonManager jsonManager,
                                                    IXmlManager xmlManager,
                                                    ISpincastConfig spincastConfig,
                                                    ISpincastUtils spincastUtils,
                                                    IETagFactory etagFactory)

Method Detail

getRequestContext

protected R getRequestContext()

getServer

protected IServer getServer()

getExchange

protected Object getExchange()

getJsonManager

protected IJsonManager getJsonManager()

getXmlManager

protected IXmlManager getXmlManager()

getSpincastConfig

protected ISpincastConfig getSpincastConfig()

getSpincastUtils

protected ISpincastUtils getSpincastUtils()

getEtagFactory

protected IETagFactory getEtagFactory()

getBuffer

protected ByteArrayOutputStream getBuffer()

getOut

protected ByteArrayOutputStream getOut()

getGzipBuffer

public GZIPOutputStream getGzipBuffer()

isRequestSizeValidated

protected boolean isRequestSizeValidated()

setRequestSizeValidated

protected void setRequestSizeValidated(boolean requestSizeValidated)

setGzipOption

public IResponseRequestContextAddon<R> setGzipOption(GzipOption gzipOption)

Description copied from interface: IResponseRequestContextAddon

Enable or disable gzipping of the response. The default is GzipOption.DEFAULT which will gzip the response only for some Content-Types and only if a gzip 'Accept-Encoding' header has been received from the client.

Specified by:

setGzipOption in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getGzipOption

public GzipOption getGzipOption()

Description copied from interface: IResponseRequestContextAddon

The currently set gzip options.

Specified by:

getGzipOption in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getStatusCode

public int getStatusCode()

Description copied from interface: IResponseRequestContextAddon

The current status code sent or to be send.

Specified by:

getStatusCode in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setStatusCode

public IResponseRequestContextAddon<R> setStatusCode(int responseStatusCode)

Description copied from interface: IResponseRequestContextAddon

Sets the response's status code to use. Uses 200 by default. Note that this status code can be changed automatically if an exception is thrown.

Specified by:

setStatusCode in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getContentType

public String getContentType()

Description copied from interface: IResponseRequestContextAddon

The current Content-Type sent or to be send.

Specified by:

getContentType in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setContentType

public IResponseRequestContextAddon<R> setContentType(String responseContentType)

Description copied from interface: IResponseRequestContextAddon

The Content-Type header to use for the response. Most sendXXX() methods will set this automatically.

Specified by:

setContentType in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isResponseCharactersBased

protected boolean isResponseCharactersBased()

Try to determine is the response is characters based or not. This is allow us to use a default Content-Type header if none was specified.

isClosed

public boolean isClosed()

Description copied from interface: IResponseRequestContextAddon

Is the response closed? If so, nothing more can be sent...

Specified by:

isClosed in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

redirect

public void redirect(String newUrl,
                     boolean permanently)

Description copied from interface: IResponseRequestContextAddon

Sets a redirection header. This will NOT close the response and will NOT skip the remaining handlers! Throw a RedirectException instead if you want to redirect the user immediately.

Specified by:

redirect in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

permanently - If true, a 301 header will be sent. If false, 302 will be sent.

redirect

public void redirect(String newUrl,
                     int specific3xxCode)

Description copied from interface: IResponseRequestContextAddon

Sets the redirection headers with a specified 3xx status code. This will NOT close the response and will NOT skip the remaining handlers! Throw a RedirectException instead if you want to redirect the user immediately.

Specified by:

redirect in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendBytes

public void sendBytes(byte[] bytes)

Description copied from interface: IResponseRequestContextAddon

Sends some bytes, without flushing.

Specified by:

sendBytes in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendBytes

public void sendBytes(byte[] bytes,
                      String contentType)

Description copied from interface: IResponseRequestContextAddon

Sends some bytes using the specified Content-Type, without flushing.

Specified by:

sendBytes in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendBytes

public void sendBytes(byte[] bytes,
                      String contentType,
                      boolean flush)

Send some bytes + flush if specified.

Specified by:

sendBytes in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

send

protected void send(byte[] bytes,
                    String contentType,
                    boolean flush)

sendCharacters

public void sendCharacters(String content)

Description copied from interface: IResponseRequestContextAddon

Sends a String, using the encoding returned by getCharactersCharsetName, without flushing.

Specified by:

sendCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendCharacters

public void sendCharacters(String content,
                           String contentType)

Description copied from interface: IResponseRequestContextAddon

Sends a String, using the encoding returned by getCharactersCharsetName and using the specified Content-Type, without flushing.

Specified by:

sendCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendCharacters

public void sendCharacters(String content,
                           String contentType,
                           boolean flush)

Description copied from interface: IResponseRequestContextAddon

Sends a String, using the encoding returned by getCharactersCharsetName and using the specified Content-Type. Flushes the response, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getCharactersCharsetName

public String getCharactersCharsetName()

Description copied from interface: IResponseRequestContextAddon

The charset to use to convert characters to bytes. Defaults to "UTF-8".

Specified by:

getCharactersCharsetName in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setCharactersCharsetName

public IResponseRequestContextAddon<R> setCharactersCharsetName(String charactersCharsetName)

Description copied from interface: IResponseRequestContextAddon

Sets the charset to use to convert characters to bytes. Defaults to "UTF-8". Make sure you use the same charset here than the one that is sent as the "Content-Type" header (which is also "UTF-8" by default, if you send data using sendPlainText(), sendHtml() or sendJson()).

Specified by:

setCharactersCharsetName in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendPlainText

public void sendPlainText(String string)

Description copied from interface: IResponseRequestContextAddon

Sends a String as text/plain, UTF-8 encoded, without flushing.

Specified by:

sendPlainText in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendPlainText

public void sendPlainText(String string,
                          boolean flush)

Description copied from interface: IResponseRequestContextAddon

Sends a String as text/plain, UTF-8 encoded, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendPlainText in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendHtml

public void sendHtml(String html)

Description copied from interface: IResponseRequestContextAddon

Sends a String as text/html, UTF-8 encoded, without flushing.

Specified by:

sendHtml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendHtml

public void sendHtml(String string,
                     boolean flush)

Description copied from interface: IResponseRequestContextAddon

Sends a String as text/html, UTF-8 encoded, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendHtml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendHtmlParse

public void sendHtmlParse(String html,
                          Map<String,Object> params)

Description copied from interface: IResponseRequestContextAddon

Parses the given String using the ITemplatingEngine and the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.

Specified by:

sendHtmlParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendHtmlParse

public void sendHtmlParse(String html,
                          Map<String,Object> params,
                          boolean flush)

Description copied from interface: IResponseRequestContextAddon

Parses the given String using the ITemplatingEngine and the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendHtmlParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendParse

public void sendParse(String content,
                      String contentType,
                      Map<String,Object> params)

Description copied from interface: IResponseRequestContextAddon

Parses the given String using the ITemplatingEngine and the given parameters, then sends the result using the specified Content-Type, without flushing.

Specified by:

sendParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendParse

public void sendParse(String content,
                      String contentType,
                      Map<String,Object> params,
                      boolean flush)

Description copied from interface: IResponseRequestContextAddon

Parses the given String using the ITemplatingEngine and the given parameters, then sends the result using the specified Content-Type, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendHtmlTemplate

public void sendHtmlTemplate(String templatePath,
                             Map<String,Object> params)

Description copied from interface: IResponseRequestContextAddon

Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.

Specified by:

sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Parameters:

templatePath - must be a classpath's relative path.

sendHtmlTemplate

public void sendHtmlTemplate(String templatePath,
                             boolean isClasspathPath,
                             Map<String,Object> params)

Description copied from interface: IResponseRequestContextAddon

Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.

Specified by:

sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isClasspathPath - if true, the 'templatePath' is considered as a classpath's relative path. If false, it is considered as an absolute file system path.

sendHtmlTemplate

public void sendHtmlTemplate(String templatePath,
                             Map<String,Object> params,
                             boolean flush)

Description copied from interface: IResponseRequestContextAddon

Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Parameters:

templatePath - must be a classpath's relative path.

sendHtmlTemplate

public void sendHtmlTemplate(String templatePath,
                             boolean isClasspathPath,
                             Map<String,Object> params,
                             boolean flush)

Description copied from interface: IResponseRequestContextAddon

Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isClasspathPath - if true, the 'templatePath' is considered as a classpath's relative path. If false, it is considered as an absolute file system path.

sendTemplate

public void sendTemplate(String templatePath,
                         String contentType,
                         Map<String,Object> params)

Description copied from interface: IResponseRequestContextAddon

Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, without flushing.

Specified by:

sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Parameters:

templatePath - must be a classpath's relative path.

sendTemplate

public void sendTemplate(String templatePath,
                         boolean isClasspathPath,
                         String contentType,
                         Map<String,Object> params)

Description copied from interface: IResponseRequestContextAddon

Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, without flushing.

Specified by:

sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isClasspathPath - if true, the 'templatePath' is considered as a classpath's relative path. If false, it is considered as an absolute file system path.

sendTemplate

public void sendTemplate(String templatePath,
                         String contentType,
                         Map<String,Object> params,
                         boolean flush)

Description copied from interface: IResponseRequestContextAddon

Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Parameters:

templatePath - must be a classpath's relative path.

sendTemplate

public void sendTemplate(String templatePath,
                         boolean isClasspathPath,
                         String contentType,
                         Map<String,Object> params,
                         boolean flush)

Description copied from interface: IResponseRequestContextAddon

Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isClasspathPath - if true, the 'templatePath' is considered as a classpath's relative path. If false, it is considered as an absolute file system path.

sendJson

public void sendJson(String jsonString)

Description copied from interface: IResponseRequestContextAddon

Sends a Json String using the application/json Content-Type, without flushing.

Synonym of : sendCharacters(jsonString, "application/json")

Specified by:

sendJson in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendJson

public void sendJson(String jsonString,
                     boolean flush)

Description copied from interface: IResponseRequestContextAddon

Sends a Json String using the application/json Content-Type, and flushes, if specified.

Note that once the response is flushed, no header can be added or changed anymore.

Synonym of : sendCharacters(jsonString, "application/json", flush)

Specified by:

sendJson in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendJsonObj

public void sendJsonObj(Object obj)

Description copied from interface: IResponseRequestContextAddon

Serializes the object to Json and sends as application/json, without flushing.

Specified by:

sendJsonObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendJsonObj

public void sendJsonObj(Object obj,
                        boolean flush)

Description copied from interface: IResponseRequestContextAddon

Serializes the object to Json, sends as application/json, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendJsonObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendXml

public void sendXml(String xml)

Description copied from interface: IResponseRequestContextAddon

Sends some XML using the application/xml Content-Type, without flushing.

Synonym of : sendCharacters(xml, "application/xml")

Specified by:

sendXml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendXml

public void sendXml(String xml,
                    boolean flush)

Description copied from interface: IResponseRequestContextAddon

Sends some XML using the application/xml Content-Type, and flushes, if specified.

Note that once the response is flushed, no header can be added or changed anymore.

Synonym of : sendCharacters(xml, "application/xml", flush)

Specified by:

sendXml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendXmlObj

public void sendXmlObj(Object obj)

Description copied from interface: IResponseRequestContextAddon

Serializes the object to XML and sends as application/xml, without flushing.

Specified by:

sendXmlObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

sendXmlObj

public void sendXmlObj(Object obj,
                       boolean flush)

Description copied from interface: IResponseRequestContextAddon

Serializes the object to XML, sends as application/xml, and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

sendXmlObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

resetBuffer

public IResponseRequestContextAddon<R> resetBuffer()

Description copied from interface: IResponseRequestContextAddon

Clears the buffer (the unsent buffer, of course).

Specified by:

resetBuffer in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

resetEverything

public IResponseRequestContextAddon<R> resetEverything()

Description copied from interface: IResponseRequestContextAddon

Clears the buffer (the unsent buffer, of course), resets the cookies, the headers, the Content-Type and sets the status code back to 200.

Specified by:

resetEverything in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getUnsentBytes

public byte[] getUnsentBytes()

Description copied from interface: IResponseRequestContextAddon

Gets the current unsent bytes (AKA the buffer).

Specified by:

getUnsentBytes in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getUnsentCharacters

public String getUnsentCharacters()

Description copied from interface: IResponseRequestContextAddon

Gets the current unsent characters (AKA the buffer), using the UTF-8 encoding.

Specified by:

getUnsentCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getUnsentCharacters

public String getUnsentCharacters(String encoding)

Description copied from interface: IResponseRequestContextAddon

Gets the current unsent characters (AKA the buffer), using the specified encoding.

Specified by:

getUnsentCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

removeHeader

public IResponseRequestContextAddon<R> removeHeader(String name)

Description copied from interface: IResponseRequestContextAddon

Removes an header by its name.

Specified by:

removeHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setHeader

public IResponseRequestContextAddon<R> setHeader(String name,
                                                 String value)

Description copied from interface: IResponseRequestContextAddon

Set the value to a response header. If the header already exists, its current values are overwritten. If the value is null, the header will be removed (same behavior as removeHeader(String name))

Specified by:

setHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setHeader

public IResponseRequestContextAddon<R> setHeader(String name,
                                                 List<String> values)

Description copied from interface: IResponseRequestContextAddon

Set multiple values to a response header. If the header already exists, its current values are overwritten. If the lists is null or empty, the header will be removed (same behavior as removeHeader(String name))

Specified by:

setHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

addHeaderValue

public IResponseRequestContextAddon<R> addHeaderValue(String name,
                                                      String value)

Description copied from interface: IResponseRequestContextAddon

Adds a value to a response header. If the header already has values, the new one is added. If the value is null, it won't be added.

Specified by:

addHeaderValue in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

addHeaderValues

public IResponseRequestContextAddon<R> addHeaderValues(String name,
                                                       List<String> values)

Description copied from interface: IResponseRequestContextAddon

Adds a list of values to a response header. If the header already has values, the new ones are added. If the values are null, nothing will be added.

Specified by:

addHeaderValues in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getHeaders

public Map<String,List<String>> getHeaders()

Description copied from interface: IResponseRequestContextAddon

The currently set response headers. The map is mutable! Also the returned implementation is a TreeMap with case insensitive keys.

Specified by:

getHeaders in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getHeader

public List<String> getHeader(String name)

Description copied from interface: IResponseRequestContextAddon

The values of a specific response header. The list is mutable! The name is case insensitive. Returns an empty list if the header was not found.

Specified by:

getHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

getHeaderFirst

public String getHeaderFirst(String name)

Description copied from interface: IResponseRequestContextAddon

The first value of a specific header. The name is case insensitive. Returns null if the header is not found.

Specified by:

getHeaderFirst in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isHeadersSent

public boolean isHeadersSent()

Description copied from interface: IResponseRequestContextAddon

Are the response headers sent? If this is the case, then the headers can't be changed anymore.

Specified by:

isHeadersSent in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setIsShouldGzip

protected void setIsShouldGzip(Boolean isShouldGzip)

isShouldGzip

protected boolean isShouldGzip()

end

public void end()

Description copied from interface: IResponseRequestContextAddon

Flushes everything and closes the response. Nothing more can be sent after this (but the remaining route handlers will still be called).

Specified by:

end in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

flush

public void flush()

Description copied from interface: IResponseRequestContextAddon

Flushes the current response. If not already specified, a default status code and Content-Type will be added. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

flush in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

flush

public void flush(boolean end)

Description copied from interface: IResponseRequestContextAddon

Flushes the current response. If not already specified on the response, a default status code and content-type will be added. Note that once the response is flushed, no header can be added or changed anymore.

Specified by:

flush in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Parameters:

end - If true, the exchange will be closed and no more data can be sent.

setCacheSeconds

public IResponseRequestContextAddon<R> setCacheSeconds(int cacheSeconds)

Description copied from interface: IResponseRequestContextAddon

Adds caching headers.

Specified by:

setCacheSeconds in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

setCacheSeconds

public IResponseRequestContextAddon<R> setCacheSeconds(int cacheSeconds,
                                                       boolean isPrivateCache)

Description copied from interface: IResponseRequestContextAddon

Adds caching headers for the specified number of seconds. Adds caching headers.

Specified by:

setCacheSeconds in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

isPrivateCache - if true, the cache will be flagged as "private".