Package org.exoplatform.services.rest

Interface GenericContainerRequest

All Superinterfaces:

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

All Known Implementing Classes:

ContainerRequest, ServletContainerRequest

public interface GenericContainerRequest
extends javax.ws.rs.core.Request, javax.ws.rs.core.SecurityContext, ExtHttpHeaders

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

Method Summary

Modifier and Type	Method	Description
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.
URI	getBaseUri()
List<String>	getCookieHeaders()	Get read-only list of cookie header.
InputStream	getEntityStream()	Get entity body represented by InputStream.
URI	getRequestUri()
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 interface javax.ws.rs.core.HttpHeaders

getAcceptableLanguages, getAcceptableMediaTypes, getCookies, getLanguage, getMediaType, getRequestHeader, getRequestHeaders

Methods inherited from interface javax.ws.rs.core.Request

evaluatePreconditions, evaluatePreconditions, evaluatePreconditions, evaluatePreconditions, getMethod, selectVariant

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

getAuthenticationScheme, getUserPrincipal, isSecure, isUserInRole

Method Details

getCookieHeaders

List<String> getCookieHeaders()

Get read-only list of cookie header.

Returns:

cookie as it get in request

getAcceptableMediaType

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.

Parameters:

mediaTypes - the list of media types

Returns:

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

getEntityStream

InputStream getEntityStream()

Get entity body represented by InputStream.

Returns:

entity data stream or null if no entity in request

getRequestUri

URI getRequestUri()

Returns:

full request URI include query string and fragment

getBaseUri

URI getBaseUri()

Returns:

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

setMethod

void setMethod(String method)

Set HTTP method.

Parameters:

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

setEntityStream

void setEntityStream(InputStream entityStream)

Set entity body InputStream.

Parameters:

entityStream - request message body as stream

setUris

void setUris(URI requestUri,
 URI baseUri)

Set new request URI and base URI.

Parameters:

requestUri - request URI

baseUri - base URI

setCookieHeaders

void setCookieHeaders(List<String> cookieHeaders)

Set list of cookie headers.

Parameters:

cookieHeaders - list of cookies as sources string

setRequestHeaders

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

Set HTTP request headers.

Parameters:

httpHeaders - read-only case insensitive MultivaluedMap