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

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

All Implemented Interfaces:: IRequestRequestContextAddon<R>

public class SpincastRequestRequestContextAddon<R extends IRequestContext<?>>
extends Object
implements IRequestRequestContextAddon<R>

Field Summary

Fields
Modifier and Type Field and Description

protected org.slf4j.Logger logger

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getBodyAsByteArray()`
`InputStream`	`getBodyAsInputStream()`
`String`	`getBodyAsString()`
`String`	`getBodyAsString(String encoding)`
`String`	`getContentType()`
`ContentTypeDefaults`	`getContentTypeBestMatch()`
`Date`	`getDateFromIfModifiedSinceHeader()`
`Date`	`getDateFromIfUnmodifiedSinceHeader()`
`protected IETagFactory`	`getEtagFactory()`
`List<IETag>`	`getEtagsFromIfMatchHeader()`
`List<IETag>`	`getEtagsFromIfNoneMatchHeader()`
`protected Object`	`getExchange()`
`List<String>`	`getFormData(String name)`
`String`	`getFormDataFirst(String name)`
`Map<String,List<String>>`	`getFormDatas()`
`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()`
`<T> T`	`getJsonBody(Class<T> clazz)`
`IJsonObject`	`getJsonBodyAsJsonObject()`
`Map<String,Object>`	`getJsonBodyAsMap()`
`protected IJsonManager`	`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 IServer`	`getServer()`
`protected ISpincastConfig`	`getSpincastConfig()`
`protected ISpincastUtils`	`getSpincastUtils()`
`File`	`getUploadedFileFirst(String name)`
`Map<String,List<File>>`	`getUploadedFiles()`
`List<File>`	`getUploadedFiles(String name)`
`<T> T`	`getXmlBody(Class<T> clazz)`
`IJsonObject`	`getXmlBodyAsJsonObject()`
`Map<String,Object>`	`getXmlBodyAsMap()`
`protected IXmlManager`	`getXmlManager()`
`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<IETag>`	`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 final org.slf4j.Logger logger
```
- Constructor Detail
  - SpincastRequestRequestContextAddon
```
@Inject
public SpincastRequestRequestContextAddon(R requestContext,
                                                   IServer server,
                                                   IJsonManager jsonManager,
                                                   IXmlManager xmlManager,
                                                   ISpincastUtils spincastUtils,
                                                   ISpincastConfig spincastConfig,
                                                   IETagFactory etagFactory)
```
- Method Detail
  - getRequestContext
```
protected R getRequestContext()
```
  - getServer
```
protected IServer getServer()
```
  - getJsonManager
```
protected IJsonManager getJsonManager()
```
  - getXmlManager
```
protected IXmlManager getXmlManager()
```
  - getSpincastUtils
```
protected ISpincastUtils getSpincastUtils()
```
  - getSpincastConfig
```
protected ISpincastConfig getSpincastConfig()
```
  - getEtagFactory
```
protected IETagFactory getEtagFactory()
```
  - getExchange
```
protected Object getExchange()
```
  - getHttpMethod
```
public HttpMethod getHttpMethod()
```
    Specified by:
    
    getHttpMethod in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getContentTypeBestMatch
```
public ContentTypeDefaults getContentTypeBestMatch()
```
    Specified by:
    
    getContentTypeBestMatch in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - isJsonShouldBeReturn
```
public boolean isJsonShouldBeReturn()
```
    Specified by:
    
    isJsonShouldBeReturn in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - isHTMLShouldBeReturn
```
public boolean isHTMLShouldBeReturn()
```
    Specified by:
    
    isHTMLShouldBeReturn in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - isXMLShouldBeReturn
```
public boolean isXMLShouldBeReturn()
```
    Specified by:
    
    isXMLShouldBeReturn in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - isPlainTextShouldBeReturn
```
public boolean isPlainTextShouldBeReturn()
```
    Specified by:
    
    isPlainTextShouldBeReturn in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getHeaders
```
public Map<String,List<String>> getHeaders()
```
    Specified by:
    
    getHeaders in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getHeader
```
public List<String> getHeader(String name)
```
    Specified by:
    
    getHeader in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getHeaderFirst
```
public String getHeaderFirst(String name)
```
    Specified by:
    
    getHeaderFirst in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - 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 IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFullUrlOriginal
```
public String getFullUrlOriginal(boolean keepCacheBusters)
```
    Specified by:
    
    getFullUrlOriginal in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFullUrlProxied
```
public String getFullUrlProxied()
```
    Specified by:
    
    getFullUrlProxied in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFullUrlProxied
```
public String getFullUrlProxied(boolean keepCacheBusters)
```
    Specified by:
    
    getFullUrlProxied in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFullUrl
```
public String getFullUrl()
```
    Specified by:
    
    getFullUrl in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFullUrl
```
public String getFullUrl(boolean keepCacheBusters)
```
    Specified by:
    
    getFullUrl in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - 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 IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getRequestPath
```
public String getRequestPath(boolean keepCacheBusters)
```
    Specified by:
    
    getRequestPath in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getQueryString
```
public String getQueryString(boolean withQuestionMark)
```
    Specified by:
    
    getQueryString in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getQueryStringParams
```
public Map<String,List<String>> getQueryStringParams()
```
    Specified by:
    
    getQueryStringParams in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getQueryStringParam
```
public List<String> getQueryStringParam(String name)
```
    Specified by:
    
    getQueryStringParam in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getQueryStringParamFirst
```
public String getQueryStringParamFirst(String name)
```
    Specified by:
    
    getQueryStringParamFirst in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getPathParams
```
public Map<String,String> getPathParams()
```
    Specified by:
    
    getPathParams in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getPathParam
```
public String getPathParam(String name)
```
    Specified by:
    
    getPathParam in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getBodyAsInputStream
```
public InputStream getBodyAsInputStream()
```
    Specified by:
    
    getBodyAsInputStream in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getBodyAsString
```
public String getBodyAsString()
```
    Specified by:
    
    getBodyAsString in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getBodyAsString
```
public String getBodyAsString(String encoding)
```
    Specified by:
    
    getBodyAsString in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getBodyAsByteArray
```
public byte[] getBodyAsByteArray()
```
    Specified by:
    
    getBodyAsByteArray in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getJsonBodyAsJsonObject
```
public IJsonObject getJsonBodyAsJsonObject()
```
    Specified by:
    
    getJsonBodyAsJsonObject in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getJsonBodyAsMap
```
public Map<String,Object> getJsonBodyAsMap()
```
    Specified by:
    
    getJsonBodyAsMap in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getJsonBody
```
public <T> T getJsonBody(Class<T> clazz)
```
    Specified by:
    
    getJsonBody in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getXmlBodyAsJsonObject
```
public IJsonObject getXmlBodyAsJsonObject()
```
    Specified by:
    
    getXmlBodyAsJsonObject in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getXmlBodyAsMap
```
public Map<String,Object> getXmlBodyAsMap()
```
    Specified by:
    
    getXmlBodyAsMap in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getXmlBody
```
public <T> T getXmlBody(Class<T> clazz)
```
    Specified by:
    
    getXmlBody in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFormDatas
```
public Map<String,List<String>> getFormDatas()
```
    Specified by:
    
    getFormDatas in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFormData
```
public List<String> getFormData(String name)
```
    Specified by:
    
    getFormData in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getFormDataFirst
```
public String getFormDataFirst(String name)
```
    Specified by:
    
    getFormDataFirst in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getUploadedFiles
```
public Map<String,List<File>> getUploadedFiles()
```
    Specified by:
    
    getUploadedFiles in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getUploadedFiles
```
public List<File> getUploadedFiles(String name)
```
    Specified by:
    
    getUploadedFiles in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getUploadedFileFirst
```
public File getUploadedFileFirst(String name)
```
    Specified by:
    
    getUploadedFileFirst in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getLocaleBestMatch
```
public Locale getLocaleBestMatch()
```
    Specified by:
    
    getLocaleBestMatch in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - isHttps
```
public boolean isHttps()
```
    Specified by:
    
    isHttps in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getEtagsFromIfMatchHeader
```
public List<IETag> getEtagsFromIfMatchHeader()
```
    Specified by:
    
    getEtagsFromIfMatchHeader in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getEtagsFromIfNoneMatchHeader
```
public List<IETag> getEtagsFromIfNoneMatchHeader()
```
    Specified by:
    
    getEtagsFromIfNoneMatchHeader in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - parseETagHeader
```
protected List<IETag> parseETagHeader(String headerName)
```
  - getDateFromIfModifiedSinceHeader
```
public Date getDateFromIfModifiedSinceHeader()
```
    Specified by:
    
    getDateFromIfModifiedSinceHeader in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - getDateFromIfUnmodifiedSinceHeader
```
public Date getDateFromIfUnmodifiedSinceHeader()
```
    Specified by:
    
    getDateFromIfUnmodifiedSinceHeader in interface IRequestRequestContextAddon<R extends IRequestContext<?>>
  - parseDateHeader
```
protected Date parseDateHeader(String headerName)
```
    Returns NULL if the date is not there or not parsable.

Class SpincastRequestRequestContextAddon<R extends IRequestContext<?>>

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

getExchange

getHttpMethod

getContentTypeBestMatch

isJsonShouldBeReturn

isHTMLShouldBeReturn

isXMLShouldBeReturn

isPlainTextShouldBeReturn

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

getBodyAsString

getBodyAsByteArray

getJsonBodyAsJsonObject

getJsonBodyAsMap

getJsonBody

getXmlBodyAsJsonObject

getXmlBodyAsMap

getXmlBody

getFormDatas

getFormData

getFormDataFirst

getUploadedFiles

getUploadedFiles

getUploadedFileFirst

getLocaleBestMatch

getContentType

isHttps

getEtagsFromIfMatchHeader

getEtagsFromIfNoneMatchHeader

parseETagHeader

getDateFromIfModifiedSinceHeader

getDateFromIfUnmodifiedSinceHeader

parseDateHeader