SpincastResponseRequestContextAddon (org.spincast:spincast-plugins-response 0.9.23 API)

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeaderValue(String name, String value)`
`void`	`addHeaderValues(String name, List<String> values)`
`void`	`end()`
`void`	`flush()`
`void`	`flush(boolean end)`
`protected ByteArrayOutputStream`	`getBuffer()`
`String`	`getCharactersCharsetName()`
`String`	`getContentType()`
`protected Object`	`getExchange()`
`GZIPOutputStream`	`getGzipBuffer()`
`GzipOption`	`getGzipOption()`
`List<String>`	`getHeader(String name)`
`String`	`getHeaderFirst(String name)`
`Map<String,List<String>>`	`getHeaders()`
`protected IJsonManager`	`getJsonManager()`
`protected ByteArrayOutputStream`	`getOut()`
`protected R`	`getRequestContext()`
`protected IServer`	`getServer()`
`protected ISpincastConfig`	`getSpincastConfig()`
`protected ISpincastUtils`	`getSpincastUtils()`
`int`	`getStatusCode()`
`byte[]`	`getUnsentBytes()`
`String`	`getUnsentCharacters()`
`String`	`getUnsentCharacters(String encoding)`
`protected IXmlManager`	`getXmlManager()`
`boolean`	`isClosed()`
`boolean`	`isHeadersSent()`
`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)`
`void`	`redirect(String newUrl, int specific3xxCode)`
`void`	`removeHeader(String name)`
`void`	`resetBuffer()`
`void`	`resetEverything()`
`protected void`	`send(byte[] bytes, String contentType, boolean flush)`
`void`	`sendBytes(byte[] bytes)`
`void`	`sendBytes(byte[] bytes, String contentType)`
`void`	`sendBytes(byte[] bytes, String contentType, boolean flush)` Send some bytes + flush if specified.
`void`	`sendCharacters(String content)`
`void`	`sendCharacters(String content, String contentType)`
`void`	`sendCharacters(String content, String contentType, boolean flush)`
`void`	`sendHtml(String html)`
`void`	`sendHtml(String string, boolean flush)`
`void`	`sendHtmlParse(String html, Map<String,Object> params)`
`void`	`sendHtmlParse(String html, Map<String,Object> params, boolean flush)`
`void`	`sendHtmlTemplate(String templatePath, boolean isClasspathPath, Map<String,Object> params)`
`void`	`sendHtmlTemplate(String templatePath, boolean isClasspathPath, Map<String,Object> params, boolean flush)`
`void`	`sendHtmlTemplate(String templatePath, Map<String,Object> params)`
`void`	`sendHtmlTemplate(String templatePath, Map<String,Object> params, boolean flush)`
`void`	`sendJson(String jsonString)`
`void`	`sendJson(String jsonString, boolean flush)`
`void`	`sendJsonObj(Object obj)`
`void`	`sendJsonObj(Object obj, boolean flush)`
`void`	`sendParse(String content, String contentType, Map<String,Object> params)`
`void`	`sendParse(String content, String contentType, Map<String,Object> params, boolean flush)`
`void`	`sendPlainText(String string)`
`void`	`sendPlainText(String string, boolean flush)`
`void`	`sendTemplate(String templatePath, boolean isClasspathPath, String contentType, Map<String,Object> params)`
`void`	`sendTemplate(String templatePath, boolean isClasspathPath, String contentType, Map<String,Object> params, boolean flush)`
`void`	`sendTemplate(String templatePath, String contentType, Map<String,Object> params)`
`void`	`sendTemplate(String templatePath, String contentType, Map<String,Object> params, boolean flush)`
`void`	`sendXml(String xml)`
`void`	`sendXml(String xml, boolean flush)`
`void`	`sendXmlObj(Object obj)`
`void`	`sendXmlObj(Object obj, boolean flush)`
`void`	`setCharactersCharsetName(String charactersCharsetName)`
`void`	`setContentType(String responseContentType)`
`void`	`setGzipOption(GzipOption gzipOption)`
`void`	`setHeader(String name, List<String> values)`
`void`	`setHeader(String name, String value)`
`protected void`	`setIsShouldGzip(Boolean isShouldGzip)`
`protected void`	`setRequestSizeValidated(boolean requestSizeValidated)`
`void`	`setStatusCode(int responseStatusCode)`

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)

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()
```
- getBuffer
```
protected ByteArrayOutputStream getBuffer()
```
- getOut
```
protected ByteArrayOutputStream getOut()
```
- getGzipBuffer
```
public GZIPOutputStream getGzipBuffer()
```
- isRequestSizeValidated
```
protected boolean isRequestSizeValidated()
```
- setRequestSizeValidated
```
protected void setRequestSizeValidated(boolean requestSizeValidated)
```
- setGzipOption
```
public void setGzipOption(GzipOption gzipOption)
```
  Specified by:
  
  setGzipOption in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getGzipOption
```
public GzipOption getGzipOption()
```
  Specified by:
  
  getGzipOption in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getStatusCode
```
public int getStatusCode()
```
  Specified by:
  
  getStatusCode in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- setStatusCode
```
public void setStatusCode(int responseStatusCode)
```
  Specified by:
  
  setStatusCode in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getContentType
```
public String getContentType()
```
  Specified by:
  
  getContentType in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- setContentType
```
public void setContentType(String responseContentType)
```
  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()
```
  Specified by:
  
  isClosed in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- redirect
```
public void redirect(String newUrl,
                     boolean permanently)
```
  Specified by:
  
  redirect in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- redirect
```
public void redirect(String newUrl,
                     int specific3xxCode)
```
  Specified by:
  
  redirect in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendBytes
```
public void sendBytes(byte[] bytes)
```
  Specified by:
  
  sendBytes in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendBytes
```
public void sendBytes(byte[] bytes,
                      String contentType)
```
  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)
```
  Specified by:
  
  sendCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendCharacters
```
public void sendCharacters(String content,
                           String contentType)
```
  Specified by:
  
  sendCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendCharacters
```
public void sendCharacters(String content,
                           String contentType,
                           boolean flush)
```
  Specified by:
  
  sendCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getCharactersCharsetName
```
public String getCharactersCharsetName()
```
  Specified by:
  
  getCharactersCharsetName in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- setCharactersCharsetName
```
public void setCharactersCharsetName(String charactersCharsetName)
```
  Specified by:
  
  setCharactersCharsetName in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendPlainText
```
public void sendPlainText(String string)
```
  Specified by:
  
  sendPlainText in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendPlainText
```
public void sendPlainText(String string,
                          boolean flush)
```
  Specified by:
  
  sendPlainText in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtml
```
public void sendHtml(String html)
```
  Specified by:
  
  sendHtml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtml
```
public void sendHtml(String string,
                     boolean flush)
```
  Specified by:
  
  sendHtml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtmlParse
```
public void sendHtmlParse(String html,
                          Map<String,Object> params)
```
  Specified by:
  
  sendHtmlParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtmlParse
```
public void sendHtmlParse(String html,
                          Map<String,Object> params,
                          boolean flush)
```
  Specified by:
  
  sendHtmlParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendParse
```
public void sendParse(String content,
                      String contentType,
                      Map<String,Object> params)
```
  Specified by:
  
  sendParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendParse
```
public void sendParse(String content,
                      String contentType,
                      Map<String,Object> params,
                      boolean flush)
```
  Specified by:
  
  sendParse in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtmlTemplate
```
public void sendHtmlTemplate(String templatePath,
                             Map<String,Object> params)
```
  Specified by:
  
  sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtmlTemplate
```
public void sendHtmlTemplate(String templatePath,
                             boolean isClasspathPath,
                             Map<String,Object> params)
```
  Specified by:
  
  sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtmlTemplate
```
public void sendHtmlTemplate(String templatePath,
                             Map<String,Object> params,
                             boolean flush)
```
  Specified by:
  
  sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendHtmlTemplate
```
public void sendHtmlTemplate(String templatePath,
                             boolean isClasspathPath,
                             Map<String,Object> params,
                             boolean flush)
```
  Specified by:
  
  sendHtmlTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendTemplate
```
public void sendTemplate(String templatePath,
                         String contentType,
                         Map<String,Object> params)
```
  Specified by:
  
  sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendTemplate
```
public void sendTemplate(String templatePath,
                         boolean isClasspathPath,
                         String contentType,
                         Map<String,Object> params)
```
  Specified by:
  
  sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendTemplate
```
public void sendTemplate(String templatePath,
                         String contentType,
                         Map<String,Object> params,
                         boolean flush)
```
  Specified by:
  
  sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendTemplate
```
public void sendTemplate(String templatePath,
                         boolean isClasspathPath,
                         String contentType,
                         Map<String,Object> params,
                         boolean flush)
```
  Specified by:
  
  sendTemplate in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendJson
```
public void sendJson(String jsonString)
```
  Specified by:
  
  sendJson in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendJson
```
public void sendJson(String jsonString,
                     boolean flush)
```
  Specified by:
  
  sendJson in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendJsonObj
```
public void sendJsonObj(Object obj)
```
  Specified by:
  
  sendJsonObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendJsonObj
```
public void sendJsonObj(Object obj,
                        boolean flush)
```
  Specified by:
  
  sendJsonObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendXml
```
public void sendXml(String xml)
```
  Specified by:
  
  sendXml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendXml
```
public void sendXml(String xml,
                    boolean flush)
```
  Specified by:
  
  sendXml in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendXmlObj
```
public void sendXmlObj(Object obj)
```
  Specified by:
  
  sendXmlObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- sendXmlObj
```
public void sendXmlObj(Object obj,
                       boolean flush)
```
  Specified by:
  
  sendXmlObj in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- resetBuffer
```
public void resetBuffer()
```
  Specified by:
  
  resetBuffer in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- resetEverything
```
public void resetEverything()
```
  Specified by:
  
  resetEverything in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getUnsentBytes
```
public byte[] getUnsentBytes()
```
  Specified by:
  
  getUnsentBytes in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getUnsentCharacters
```
public String getUnsentCharacters()
```
  Specified by:
  
  getUnsentCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getUnsentCharacters
```
public String getUnsentCharacters(String encoding)
```
  Specified by:
  
  getUnsentCharacters in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- removeHeader
```
public void removeHeader(String name)
```
  Specified by:
  
  removeHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- setHeader
```
public void setHeader(String name,
                      String value)
```
  Specified by:
  
  setHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- setHeader
```
public void setHeader(String name,
                      List<String> values)
```
  Specified by:
  
  setHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- addHeaderValue
```
public void addHeaderValue(String name,
                           String value)
```
  Specified by:
  
  addHeaderValue in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- addHeaderValues
```
public void addHeaderValues(String name,
                            List<String> values)
```
  Specified by:
  
  addHeaderValues in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getHeaders
```
public Map<String,List<String>> getHeaders()
```
  Specified by:
  
  getHeaders in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getHeader
```
public List<String> getHeader(String name)
```
  Specified by:
  
  getHeader in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- getHeaderFirst
```
public String getHeaderFirst(String name)
```
  Specified by:
  
  getHeaderFirst in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- isHeadersSent
```
public boolean isHeadersSent()
```
  Specified by:
  
  isHeadersSent in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- setIsShouldGzip
```
protected void setIsShouldGzip(Boolean isShouldGzip)
```
- isShouldGzip
```
protected boolean isShouldGzip()
```
- end
```
public void end()
```
  Specified by:
  
  end in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- flush
```
public void flush()
```
  Specified by:
  
  flush in interface IResponseRequestContextAddon<R extends IRequestContext<?>>
- flush
```
public void flush(boolean end)
```
  Specified by:
  
  flush in interface IResponseRequestContextAddon<R extends IRequestContext<?>>

Class SpincastResponseRequestContextAddon<R extends IRequestContext<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

IS_RESPONSE_CHARACTERS_BASED_BY_DEFAULT

Constructor Detail

SpincastResponseRequestContextAddon

Method Detail

getRequestContext

getServer

getExchange

getJsonManager

getXmlManager

getSpincastConfig

getSpincastUtils

getBuffer

getOut

getGzipBuffer

isRequestSizeValidated

setRequestSizeValidated

setGzipOption

getGzipOption

getStatusCode

setStatusCode

getContentType

setContentType

isResponseCharactersBased

isClosed

redirect

redirect

sendBytes

sendBytes

sendBytes

send

sendCharacters

sendCharacters

sendCharacters

getCharactersCharsetName

setCharactersCharsetName

sendPlainText

sendPlainText

sendHtml

sendHtml

sendHtmlParse

sendHtmlParse

sendParse

sendParse

sendHtmlTemplate

sendHtmlTemplate

sendHtmlTemplate

sendHtmlTemplate

sendTemplate

sendTemplate

sendTemplate

sendTemplate

sendJson

sendJson

sendJsonObj

sendJsonObj

sendXml

sendXml

sendXmlObj

sendXmlObj

resetBuffer

resetEverything

getUnsentBytes

getUnsentCharacters

getUnsentCharacters

removeHeader

setHeader

setHeader

addHeaderValue

addHeaderValues

getHeaders

getHeader

getHeaderFirst

isHeadersSent