Package org.exoplatform.services.rest.impl

Class ContainerRequest

java.lang.Object

org.exoplatform.services.rest.impl.ContainerRequest

All Implemented Interfaces:

javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.Request, javax.ws.rs.core.SecurityContext, ExtHttpHeaders, GenericContainerRequest

Direct Known Subclasses:

ServletContainerRequest

public class ContainerRequest
extends Object
implements GenericContainerRequest

Version:

$Id: $

Author:

Andrey Parfonov

Field Summary

Fields inherited from interface org.exoplatform.services.rest.ExtHttpHeaders

ACCEPT_RANGES, ALLOW, AUTHORIZATION, CONTENT_MIXINTYPES, CONTENT_NODETYPE, CONTENTLENGTH, CONTENTRANGE, CONTENTTYPE, DASL, DAV, DEPTH, DESTINATION, FILE_NODETYPE, FOLDER_NODETYPE, IF, LOCKTOKEN, MSAUTHORVIA, MULTIPART_BYTERANGES, OVERWRITE, RANGE, TIMEOUT, TRANSFER_ENCODING, USERAGENT, X_HTTP_METHOD_OVERRIDE

Fields inherited from interface javax.ws.rs.core.HttpHeaders

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, CACHE_CONTROL, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPIRES, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, SET_COOKIE, USER_AGENT, VARY, WWW_AUTHENTICATE

Fields inherited from interface javax.ws.rs.core.SecurityContext

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
ContainerRequest(String method, URI requestUri, URI baseUri, InputStream entityStream, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)	Constructs new instance of ContainerRequest.

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response.ResponseBuilder	evaluatePreconditions()
javax.ws.rs.core.Response.ResponseBuilder	evaluatePreconditions(Date lastModified)
javax.ws.rs.core.Response.ResponseBuilder	evaluatePreconditions(Date lastModified, javax.ws.rs.core.EntityTag etag)
javax.ws.rs.core.Response.ResponseBuilder	evaluatePreconditions(javax.ws.rs.core.EntityTag etag)
List<Locale>	getAcceptableLanguages()	If accept-language header does not present or its length is null then default language list will be returned.
javax.ws.rs.core.MediaType	getAcceptableMediaType(List<javax.ws.rs.core.MediaType> mediaTypes)	Select the first media type, from a given list of media types, that is most acceptable according to the requested acceptable media types.
List<javax.ws.rs.core.MediaType>	getAcceptableMediaTypes()	If accept header does not presents or its length is null then list with one element will be returned.
String	getAuthenticationScheme()
URI	getBaseUri()
List<String>	getCookieHeaders()	Get read-only list of cookie header.
Map<String,javax.ws.rs.core.Cookie>	getCookies()
InputStream	getEntityStream()	Get entity body represented by InputStream.
Locale	getLanguage()
javax.ws.rs.core.MediaType	getMediaType()
String	getMethod()
List<String>	getRequestHeader(String name)
javax.ws.rs.core.MultivaluedMap<String,String>	getRequestHeaders()
URI	getRequestUri()
Principal	getUserPrincipal()
boolean	isSecure()
boolean	isUserInRole(String role)
javax.ws.rs.core.Variant	selectVariant(List<javax.ws.rs.core.Variant> variants)
void	setCookieHeaders(List<String> cookieHeaders)	Set list of cookie headers.
void	setEntityStream(InputStream entityStream)	Set entity body InputStream.
void	setMethod(String method)	Set HTTP method.
void	setRequestHeaders(javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)	Set HTTP request headers.
void	setUris(URI requestUri, URI baseUri)	Set new request URI and base URI.

Methods inherited from class java.lang.Object

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

Constructor Details

ContainerRequest

public ContainerRequest(String method,
 URI requestUri,
 URI baseUri,
 InputStream entityStream,
 javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)

Constructs new instance of ContainerRequest.

Parameters:

method - HTTP method

requestUri - full request URI

baseUri - base request URI

entityStream - request message body as stream

httpHeaders - HTTP headers

Method Details

getAcceptableMediaType

public javax.ws.rs.core.MediaType getAcceptableMediaType(List<javax.ws.rs.core.MediaType> mediaTypes)

Select the first media type, from a given list of media types, that is most acceptable according to the requested acceptable media types.

Specified by:

getAcceptableMediaType in interface GenericContainerRequest

Parameters:

mediaTypes - the list of media types

Returns:

the most acceptable media type, or null if no media type was found to be acceptable

getCookieHeaders

public List<String> getCookieHeaders()

Get read-only list of cookie header.

Specified by:

getCookieHeaders in interface GenericContainerRequest

Returns:

cookie as it get in request

getEntityStream

public InputStream getEntityStream()

Get entity body represented by InputStream.

Specified by:

getEntityStream in interface GenericContainerRequest

Returns:

entity data stream or null if no entity in request

getRequestUri

public URI getRequestUri()

Specified by:

getRequestUri in interface GenericContainerRequest

Returns:

full request URI include query string and fragment

getBaseUri

public URI getBaseUri()

Specified by:

getBaseUri in interface GenericContainerRequest

Returns:

common part of URI string for all services, e. g. servlet path

setMethod

public void setMethod(String method)

Set HTTP method.

Specified by:

setMethod in interface GenericContainerRequest

Parameters:

method - HTTP method, i. e. GET, POST, etc

setEntityStream

public void setEntityStream(InputStream entityStream)

Set entity body InputStream.

Specified by:

setEntityStream in interface GenericContainerRequest

Parameters:

entityStream - request message body as stream

setUris

public void setUris(URI requestUri,
 URI baseUri)

Set new request URI and base URI.

Specified by:

setUris in interface GenericContainerRequest

Parameters:

requestUri - request URI

baseUri - base URI

setCookieHeaders

public void setCookieHeaders(List<String> cookieHeaders)

Set list of cookie headers.

Specified by:

setCookieHeaders in interface GenericContainerRequest

Parameters:

cookieHeaders - list of cookies as sources string

setRequestHeaders

public void setRequestHeaders(javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)

Set HTTP request headers.

Specified by:

setRequestHeaders in interface GenericContainerRequest

Parameters:

httpHeaders - read-only case insensitive MultivaluedMap

getAuthenticationScheme

public String getAuthenticationScheme()

Specified by:

getAuthenticationScheme in interface javax.ws.rs.core.SecurityContext

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.ws.rs.core.SecurityContext

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.ws.rs.core.SecurityContext

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface javax.ws.rs.core.SecurityContext

evaluatePreconditions

public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(javax.ws.rs.core.EntityTag etag)

Specified by:

evaluatePreconditions in interface javax.ws.rs.core.Request

evaluatePreconditions

public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(Date lastModified)

Specified by:

evaluatePreconditions in interface javax.ws.rs.core.Request

evaluatePreconditions

public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(Date lastModified,
 javax.ws.rs.core.EntityTag etag)

Specified by:

evaluatePreconditions in interface javax.ws.rs.core.Request

getMethod

public String getMethod()

Specified by:

getMethod in interface javax.ws.rs.core.Request

selectVariant

public javax.ws.rs.core.Variant selectVariant(List<javax.ws.rs.core.Variant> variants)

Specified by:

selectVariant in interface javax.ws.rs.core.Request

getAcceptableLanguages

public List<Locale> getAcceptableLanguages()

If accept-language header does not present or its length is null then default language list will be returned. This list contains only one element Locale with language '*', and it minds any language accepted.

Specified by:

getAcceptableLanguages in interface javax.ws.rs.core.HttpHeaders

getAcceptableMediaTypes

public List<javax.ws.rs.core.MediaType> getAcceptableMediaTypes()

If accept header does not presents or its length is null then list with one element will be returned. That one element is default media type, see AcceptMediaType.DEFAULT .

Specified by:

getAcceptableMediaTypes in interface javax.ws.rs.core.HttpHeaders

getCookies

public Map<String,javax.ws.rs.core.Cookie> getCookies()

Specified by:

getCookies in interface javax.ws.rs.core.HttpHeaders

getLanguage

public Locale getLanguage()

Specified by:

getLanguage in interface javax.ws.rs.core.HttpHeaders

getMediaType

public javax.ws.rs.core.MediaType getMediaType()

Specified by:

getMediaType in interface javax.ws.rs.core.HttpHeaders

getRequestHeader

public List<String> getRequestHeader(String name)

Specified by:

getRequestHeader in interface javax.ws.rs.core.HttpHeaders

getRequestHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getRequestHeaders()

Specified by:

getRequestHeaders in interface javax.ws.rs.core.HttpHeaders

evaluatePreconditions

public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions()

Specified by:

evaluatePreconditions in interface javax.ws.rs.core.Request