org.spincast.core.exchange

Interface IResponseRequestContextAddon<R extends IRequestContext<?>>

All Known Implementing Classes:

SpincastResponseRequestContextAddon

public interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Methods to manipulate the response.

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.
String	getCharactersCharsetName() The charset to use to convert characters to bytes.
String	getContentType() The current Content-Type sent or to be send.
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.
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.
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.
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.
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) Sends some bytes using the specified Content-Type and flushes, 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 html, 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 name) 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.
IResponseRequestContextAddon<R>	setStatusCode(int statusCode) Sets the response's status code to use.

Method Detail

isClosed

boolean isClosed()

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

end

void end()

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

isHeadersSent

boolean isHeadersSent()

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

sendBytes

void sendBytes(byte[] bytes)

Sends some bytes, without flushing.

sendBytes

void sendBytes(byte[] bytes,
               String contentType)

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

sendBytes

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

Sends some bytes using the specified Content-Type and flushes, if specified. Note that once the response is flushed, no header can be added or changed anymore.

getCharactersCharsetName

String getCharactersCharsetName()

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

setCharactersCharsetName

IResponseRequestContextAddon<R> setCharactersCharsetName(String name)

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()).

sendCharacters

void sendCharacters(String content)

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

sendCharacters

void sendCharacters(String content,
                    String contentType)

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

sendCharacters

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

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.

sendPlainText

void sendPlainText(String string)

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

sendPlainText

void sendPlainText(String string,
                   boolean flush)

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.

sendJson

void sendJson(String jsonString)

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

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

sendJson

void sendJson(String jsonString,
              boolean flush)

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)

sendJsonObj

void sendJsonObj(Object obj)

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

sendJsonObj

void sendJsonObj(Object obj,
                 boolean flush)

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.

sendXml

void sendXml(String xml)

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

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

sendXml

void sendXml(String xml,
             boolean flush)

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)

sendXmlObj

void sendXmlObj(Object obj)

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

sendXmlObj

void sendXmlObj(Object obj,
                boolean flush)

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.

sendHtml

void sendHtml(String html)

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

sendHtml

void sendHtml(String html,
              boolean flush)

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.

sendHtmlParse

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.

sendHtmlParse

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. Note that once the response is flushed, no header can be added or changed anymore.

sendParse

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.

sendParse

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. Note that once the response is flushed, no header can be added or changed anymore.

sendHtmlTemplate

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.

Parameters:

templatePath - must be a classpath's relative path.

sendHtmlTemplate

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. Note that once the response is flushed, no header can be added or changed anymore.

Parameters:

templatePath - must be a classpath's relative path.

sendTemplate

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.

Parameters:

templatePath - must be a classpath's relative path.

sendTemplate

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. Note that once the response is flushed, no header can be added or changed anymore.

Parameters:

templatePath - must be a classpath's relative path.

sendHtmlTemplate

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.

Parameters:

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

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. Note that once the response is flushed, no header can be added or changed anymore.

Parameters:

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

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.

Parameters:

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

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. Note that once the response is flushed, no header can be added or changed anymore.

Parameters:

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

flush

void flush()

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.

flush

void flush(boolean end)

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.

Parameters:

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

setStatusCode

IResponseRequestContextAddon<R> setStatusCode(int statusCode)

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.

getStatusCode

int getStatusCode()

The current status code sent or to be send.

setContentType

IResponseRequestContextAddon<R> setContentType(String responseContentType)

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

getContentType

String getContentType()

The current Content-Type sent or to be send.

redirect

void redirect(String newUrl,
              boolean permanently)

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.

Parameters:

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

redirect

void redirect(String newUrl,
              int specific3xxCode)

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.

addHeaderValue

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

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.

addHeaderValues

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

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.

setHeader

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

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))

setHeader

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

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))

removeHeader

IResponseRequestContextAddon<R> removeHeader(String name)

Removes an header by its name.

getHeaders

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

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

getHeader

List<String> getHeader(String name)

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.

getHeaderFirst

String getHeaderFirst(String name)

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

resetBuffer

IResponseRequestContextAddon<R> resetBuffer()

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

resetEverything

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.

getUnsentBytes

byte[] getUnsentBytes()

Gets the current unsent bytes (AKA the buffer).

getUnsentCharacters

String getUnsentCharacters()

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

getUnsentCharacters

String getUnsentCharacters(String encoding)

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

setGzipOption

IResponseRequestContextAddon<R> setGzipOption(GzipOption gzipOption)

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.

getGzipOption

GzipOption getGzipOption()

The currently set gzip options.

setCacheSeconds

IResponseRequestContextAddon<R> setCacheSeconds(int cacheSeconds)

Adds caching headers.

Parameters:

seconds - the number of seconds this response should be cached.

setCacheSeconds

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

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

Parameters:

seconds - the number of seconds this response should be cached.

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