SpincastRequestRequestContextAddon (org.spincast:spincast-plugins-request 1.13.0 API)

java.lang.Object
- org.spincast.plugins.request.SpincastRequestRequestContextAddon<R>

All Implemented Interfaces:: RequestRequestContextAddon<R>

public class SpincastRequestRequestContextAddon<R extends RequestContext<?>>
extends Object
implements RequestRequestContextAddon<R>

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger logger

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description
`SpincastRequestRequestContextAddon(R requestContext, Server server, JsonManager jsonManager, XmlManager xmlManager, SpincastUtils spincastUtils, SpincastConfig spincastConfig, ETagFactory etagFactory, FlashMessagesHolder flashMessagesHolder, FormFactory formFactory, Dictionary dictionary)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getBodyAsByteArray()`
`InputStream`	`getBodyAsInputStream()`
`String`	`getBodyAsString()`
`String`	`getContentType()`
`ContentTypeDefaults`	`getContentTypeBestMatch()`
`Map<String,String>`	`getCookiesValues()`
`String`	`getCookieValue(String name)`
`Date`	`getDateFromIfModifiedSinceHeader()`
`Date`	`getDateFromIfUnmodifiedSinceHeader()`
`protected Dictionary`	`getDictionary()`
`protected ETagFactory`	`getEtagFactory()`
`List<ETag>`	`getEtagsFromIfMatchHeader()`
`List<ETag>`	`getEtagsFromIfNoneMatchHeader()`
`protected Object`	`getExchange()`
`FlashMessage`	`getFlashMessage()`
`protected FlashMessage`	`getFlashMessage(boolean removeIt)`
`protected FlashMessagesHolder`	`getFlashMessagesHolder()`
`Form`	`getForm(String rootKey)`
`protected Form`	`getForm(String rootKey, boolean createIfNotFound)`
`JsonObject`	`getFormBodyAsJsonObject()`
`Map<String,List<String>>`	`getFormBodyRaw()`
`protected Pattern`	`getFormDataArrayPattern()`
`protected FormFactory`	`getFormFactory()`
`Form`	`getFormOrCreate(String rootKey)`
`String`	`getFullUrl()`
`String`	`getFullUrl(boolean keepCacheBusters)`
`String`	`getFullUrlOriginal()`
`String`	`getFullUrlOriginal(boolean keepCacheBusters)`
`protected String`	`getFullUrlOriginalNoCacheBustersNonDecoded()`
`protected String`	`getFullUrlOriginalWithCacheBustersNonDecoded()`
`String`	`getFullUrlProxied()`
`String`	`getFullUrlProxied(boolean keepCacheBusters)`
`protected String`	`getFullUrlProxiedNoCacheBustersNonDecoded()`
`protected String`	`getFullUrlProxiedWithCacheBustersNonDecoded()`
`List<String>`	`getHeader(String name)`
`String`	`getHeaderFirst(String name)`
`Map<String,List<String>>`	`getHeaders()`
`HttpMethod`	`getHttpMethod()`
`String`	`getIp()`
`JsonObject`	`getJsonBody()`
`<T> T`	`getJsonBody(Class<T> clazz)`
`Map<String,Object>`	`getJsonBodyAsMap()`
`protected JsonManager`	`getJsonManager()`
`Locale`	`getLocaleBestMatch()`
`String`	`getPathParam(String name)`
`Map<String,String>`	`getPathParams()`
`String`	`getQueryString(boolean withQuestionMark)`
`List<String>`	`getQueryStringParam(String name)`
`String`	`getQueryStringParamFirst(String name)`
`Map<String,List<String>>`	`getQueryStringParams()`
`protected R`	`getRequestContext()`
`String`	`getRequestPath()`
`String`	`getRequestPath(boolean keepCacheBusters)`
`protected Server`	`getServer()`
`protected SpincastConfig`	`getSpincastConfig()`
`protected SpincastUtils`	`getSpincastUtils()`
`String`	`getStringBody(String encoding)`
`UploadedFile`	`getUploadedFileFirst(String name)`
`Map<String,List<UploadedFile>>`	`getUploadedFiles()`
`List<UploadedFile>`	`getUploadedFiles(String name)`
`<T> T`	`getXmlBody(Class<T> clazz)`
`JsonObject`	`getXmlBodyAsJsonObject()`
`Map<String,Object>`	`getXmlBodyAsMap()`
`protected XmlManager`	`getXmlManager()`
`boolean`	`isCookiesEnabledValidated()`
`boolean`	`isFlashMessageExists()`
`boolean`	`isHTMLShouldBeReturn()`
`boolean`	`isHttps()`
`boolean`	`isJsonShouldBeReturn()`
`boolean`	`isPlainTextShouldBeReturn()`
`boolean`	`isXMLShouldBeReturn()`
`protected Date`	`parseDateHeader(String headerName)` Returns NULL if the date is not there or not parsable.
`protected List<ETag>`	`parseETagHeader(String headerName)`
`protected void`	`parseQueryString()`
`void`	`parseQueryStringParams()`
`protected void`	`parseRequestPath()`
`protected void`	`parseUrl()`
`protected void`	`validateFullUrlInfoCache()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected static final org.slf4j.Logger logger
```
- Constructor Detail
  - SpincastRequestRequestContextAddon
```
@Inject
public SpincastRequestRequestContextAddon(R requestContext,
                                                  Server server,
                                                  JsonManager jsonManager,
                                                  XmlManager xmlManager,
                                                  SpincastUtils spincastUtils,
                                                  SpincastConfig spincastConfig,
                                                  ETagFactory etagFactory,
                                                  FlashMessagesHolder flashMessagesHolder,
                                                  FormFactory formFactory,
                                                  Dictionary dictionary)
```
- Method Detail
  - getRequestContext
```
protected R getRequestContext()
```
  - getServer
```
protected Server getServer()
```
  - getJsonManager
```
protected JsonManager getJsonManager()
```
  - getXmlManager
```
protected XmlManager getXmlManager()
```
  - getSpincastUtils
```
protected SpincastUtils getSpincastUtils()
```
  - getSpincastConfig
```
protected SpincastConfig getSpincastConfig()
```
  - getEtagFactory
```
protected ETagFactory getEtagFactory()
```
  - getFlashMessagesHolder
```
protected FlashMessagesHolder getFlashMessagesHolder()
```
  - getFormFactory
```
protected FormFactory getFormFactory()
```
  - getDictionary
```
protected Dictionary getDictionary()
```
  - getExchange
```
protected Object getExchange()
```
  - getHttpMethod
```
public HttpMethod getHttpMethod()
```
    Specified by:
    
    getHttpMethod in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getContentTypeBestMatch
```
public ContentTypeDefaults getContentTypeBestMatch()
```
    Specified by:
    
    getContentTypeBestMatch in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - isJsonShouldBeReturn
```
public boolean isJsonShouldBeReturn()
```
    Specified by:
    
    isJsonShouldBeReturn in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - isHTMLShouldBeReturn
```
public boolean isHTMLShouldBeReturn()
```
    Specified by:
    
    isHTMLShouldBeReturn in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - isXMLShouldBeReturn
```
public boolean isXMLShouldBeReturn()
```
    Specified by:
    
    isXMLShouldBeReturn in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - isPlainTextShouldBeReturn
```
public boolean isPlainTextShouldBeReturn()
```
    Specified by:
    
    isPlainTextShouldBeReturn in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFormDataArrayPattern
```
protected Pattern getFormDataArrayPattern()
```
  - getCookieValue
```
public String getCookieValue(String name)
```
    Specified by:
    
    getCookieValue in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getCookiesValues
```
public Map<String,String> getCookiesValues()
```
    Specified by:
    
    getCookiesValues in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - isCookiesEnabledValidated
```
public boolean isCookiesEnabledValidated()
```
    Specified by:
    
    isCookiesEnabledValidated in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getHeaders
```
public Map<String,List<String>> getHeaders()
```
    Specified by:
    
    getHeaders in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getHeader
```
public List<String> getHeader(String name)
```
    Specified by:
    
    getHeader in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getHeaderFirst
```
public String getHeaderFirst(String name)
```
    Specified by:
    
    getHeaderFirst in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFullUrlOriginalNoCacheBustersNonDecoded
```
protected String getFullUrlOriginalNoCacheBustersNonDecoded()
```
  - getFullUrlOriginalWithCacheBustersNonDecoded
```
protected String getFullUrlOriginalWithCacheBustersNonDecoded()
```
  - getFullUrlProxiedNoCacheBustersNonDecoded
```
protected String getFullUrlProxiedNoCacheBustersNonDecoded()
```
  - getFullUrlProxiedWithCacheBustersNonDecoded
```
protected String getFullUrlProxiedWithCacheBustersNonDecoded()
```
  - getFullUrlOriginal
```
public String getFullUrlOriginal()
```
    Specified by:
    
    getFullUrlOriginal in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFullUrlOriginal
```
public String getFullUrlOriginal(boolean keepCacheBusters)
```
    Specified by:
    
    getFullUrlOriginal in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFullUrlProxied
```
public String getFullUrlProxied()
```
    Specified by:
    
    getFullUrlProxied in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFullUrlProxied
```
public String getFullUrlProxied(boolean keepCacheBusters)
```
    Specified by:
    
    getFullUrlProxied in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFullUrl
```
public String getFullUrl()
```
    Specified by:
    
    getFullUrl in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFullUrl
```
public String getFullUrl(boolean keepCacheBusters)
```
    Specified by:
    
    getFullUrl in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - validateFullUrlInfoCache
```
protected void validateFullUrlInfoCache()
```
  - parseUrl
```
protected void parseUrl()
```
  - parseRequestPath
```
protected void parseRequestPath()
```
  - parseQueryString
```
protected void parseQueryString()
```
  - parseQueryStringParams
```
public void parseQueryStringParams()
```
  - getRequestPath
```
public String getRequestPath()
```
    Specified by:
    
    getRequestPath in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getRequestPath
```
public String getRequestPath(boolean keepCacheBusters)
```
    Specified by:
    
    getRequestPath in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getQueryString
```
public String getQueryString(boolean withQuestionMark)
```
    Specified by:
    
    getQueryString in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getQueryStringParams
```
public Map<String,List<String>> getQueryStringParams()
```
    Specified by:
    
    getQueryStringParams in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getQueryStringParam
```
public List<String> getQueryStringParam(String name)
```
    Specified by:
    
    getQueryStringParam in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getQueryStringParamFirst
```
public String getQueryStringParamFirst(String name)
```
    Specified by:
    
    getQueryStringParamFirst in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getPathParams
```
public Map<String,String> getPathParams()
```
    Specified by:
    
    getPathParams in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getPathParam
```
public String getPathParam(String name)
```
    Specified by:
    
    getPathParam in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getBodyAsInputStream
```
public InputStream getBodyAsInputStream()
```
    Specified by:
    
    getBodyAsInputStream in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getBodyAsString
```
public String getBodyAsString()
```
    Specified by:
    
    getBodyAsString in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getStringBody
```
public String getStringBody(String encoding)
```
    Specified by:
    
    getStringBody in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getBodyAsByteArray
```
public byte[] getBodyAsByteArray()
```
    Specified by:
    
    getBodyAsByteArray in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getJsonBody
```
public JsonObject getJsonBody()
```
    Specified by:
    
    getJsonBody in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getJsonBodyAsMap
```
public Map<String,Object> getJsonBodyAsMap()
```
    Specified by:
    
    getJsonBodyAsMap in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getJsonBody
```
public <T> T getJsonBody(Class<T> clazz)
```
    Specified by:
    
    getJsonBody in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getXmlBodyAsJsonObject
```
public JsonObject getXmlBodyAsJsonObject()
```
    Specified by:
    
    getXmlBodyAsJsonObject in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getXmlBodyAsMap
```
public Map<String,Object> getXmlBodyAsMap()
```
    Specified by:
    
    getXmlBodyAsMap in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getXmlBody
```
public <T> T getXmlBody(Class<T> clazz)
```
    Specified by:
    
    getXmlBody in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFormBodyRaw
```
public Map<String,List<String>> getFormBodyRaw()
```
    Specified by:
    
    getFormBodyRaw in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFormBodyAsJsonObject
```
public JsonObject getFormBodyAsJsonObject()
```
    Specified by:
    
    getFormBodyAsJsonObject in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFormOrCreate
```
public Form getFormOrCreate(String rootKey)
```
    Specified by:
    
    getFormOrCreate in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getForm
```
public Form getForm(String rootKey)
```
    Specified by:
    
    getForm in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getForm
```
protected Form getForm(String rootKey,
                       boolean createIfNotFound)
```
  - getUploadedFiles
```
public Map<String,List<UploadedFile>> getUploadedFiles()
```
    Specified by:
    
    getUploadedFiles in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getUploadedFiles
```
public List<UploadedFile> getUploadedFiles(String name)
```
    Specified by:
    
    getUploadedFiles in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getUploadedFileFirst
```
public UploadedFile getUploadedFileFirst(String name)
```
    Specified by:
    
    getUploadedFileFirst in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getLocaleBestMatch
```
public Locale getLocaleBestMatch()
```
    Specified by:
    
    getLocaleBestMatch in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - isHttps
```
public boolean isHttps()
```
    Specified by:
    
    isHttps in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getEtagsFromIfMatchHeader
```
public List<ETag> getEtagsFromIfMatchHeader()
```
    Specified by:
    
    getEtagsFromIfMatchHeader in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getEtagsFromIfNoneMatchHeader
```
public List<ETag> getEtagsFromIfNoneMatchHeader()
```
    Specified by:
    
    getEtagsFromIfNoneMatchHeader in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - parseETagHeader
```
protected List<ETag> parseETagHeader(String headerName)
```
  - getDateFromIfModifiedSinceHeader
```
public Date getDateFromIfModifiedSinceHeader()
```
    Specified by:
    
    getDateFromIfModifiedSinceHeader in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getDateFromIfUnmodifiedSinceHeader
```
public Date getDateFromIfUnmodifiedSinceHeader()
```
    Specified by:
    
    getDateFromIfUnmodifiedSinceHeader in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - parseDateHeader
```
protected Date parseDateHeader(String headerName)
```
    Returns NULL if the date is not there or not parsable.
  - isFlashMessageExists
```
public boolean isFlashMessageExists()
```
    Specified by:
    
    isFlashMessageExists in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFlashMessage
```
public FlashMessage getFlashMessage()
```
    Specified by:
    
    getFlashMessage in interface RequestRequestContextAddon<R extends RequestContext<?>>
  - getFlashMessage
```
protected FlashMessage getFlashMessage(boolean removeIt)
```
  - getIp
```
public String getIp()
```
    Specified by:
    
    getIp in interface RequestRequestContextAddon<R extends RequestContext<?>>

Class SpincastRequestRequestContextAddon<R extends RequestContext<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

SpincastRequestRequestContextAddon

Method Detail

getRequestContext

getServer

getJsonManager

getXmlManager

getSpincastUtils

getSpincastConfig

getEtagFactory

getFlashMessagesHolder

getFormFactory

getDictionary

getExchange

getHttpMethod

getContentTypeBestMatch

isJsonShouldBeReturn

isHTMLShouldBeReturn

isXMLShouldBeReturn

isPlainTextShouldBeReturn

getFormDataArrayPattern

getCookieValue

getCookiesValues

isCookiesEnabledValidated

getHeaders

getHeader

getHeaderFirst

getFullUrlOriginalNoCacheBustersNonDecoded

getFullUrlOriginalWithCacheBustersNonDecoded

getFullUrlProxiedNoCacheBustersNonDecoded

getFullUrlProxiedWithCacheBustersNonDecoded

getFullUrlOriginal

getFullUrlOriginal

getFullUrlProxied

getFullUrlProxied

getFullUrl

getFullUrl

validateFullUrlInfoCache

parseUrl

parseRequestPath

parseQueryString

parseQueryStringParams

getRequestPath

getRequestPath

getQueryString

getQueryStringParams

getQueryStringParam

getQueryStringParamFirst

getPathParams

getPathParam

getBodyAsInputStream

getBodyAsString

getStringBody

getBodyAsByteArray

getJsonBody

getJsonBodyAsMap

getJsonBody

getXmlBodyAsJsonObject

getXmlBodyAsMap

getXmlBody

getFormBodyRaw

getFormBodyAsJsonObject

getFormOrCreate

getForm

getForm

getUploadedFiles

getUploadedFiles

getUploadedFileFirst

getLocaleBestMatch

getContentType

isHttps

getEtagsFromIfMatchHeader

getEtagsFromIfNoneMatchHeader