org.exoplatform.services.rest
Class Request

java.lang.Object
  org.exoplatform.services.rest.Request

public class Request
extends Object

Created by The eXo Platform SAS.
Request represents REST request (not HTTP request).

Version:

$Id: $

Author:

Gennady Azarenkov

Constructor Summary

Request(InputStream entityDataStream, ResourceIdentifier resourceIdentifier, String methodName, MultivaluedMetadata httpHeaderParams, MultivaluedMetadata httpQueryParams)

Request(InputStream entityDataStream, ResourceIdentifier resourceIdentifier, String methodName, MultivaluedMetadata httpHeaderParams, MultivaluedMetadata httpQueryParams, Map<String,Cookie> cookies)
Constructor with cookie support.

Method Summary

Cookie	getCookie(String name)
InputStream	getEntityStream() Return entity body represented by InputStream.
MultivaluedMetadata	getHeaderParams() Return a map of key-values pair of header parameters.
String	getMethodName() HTTP method name.
MultivaluedMetadata	getQueryParams() Return a map of key-values pair of query parameters.
ResourceIdentifier	getResourceIdentifier() get ResourceIdentifier.
void	setResourceIdentifier(ResourceIdentifier resourceIdentifier) set ResourceIdentifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request(InputStream entityDataStream,
               ResourceIdentifier resourceIdentifier,
               String methodName,
               MultivaluedMetadata httpHeaderParams,
               MultivaluedMetadata httpQueryParams,
               Map<String,Cookie> cookies)

Constructor with cookie support.

Parameters:

entityDataStream - input data stream from HTTP request (HTTP methods POST, PUT).

resourceIdentifier - @see org.exoplatform.services.rest.ResourceIdentifier.

methodName - the HTTP method (GET, POST, DELETE, etc).

httpHeaderParams - the HTTP headers.

httpQueryParams - the query parameters.

cookies - the cookies.

Request

public Request(InputStream entityDataStream,
               ResourceIdentifier resourceIdentifier,
               String methodName,
               MultivaluedMetadata httpHeaderParams,
               MultivaluedMetadata httpQueryParams)

Parameters:

entityDataStream - input data stream from HTTP request (HTTP methods POST, PUT).

resourceIdentifier - @see org.exoplatform.services.rest.ResourceIdentifier.

methodName - the HTTP method (GET, POST, DELETE, etc).

httpHeaderParams - the HTTP headers.

httpQueryParams - the query parameters.

Method Detail

getEntityStream

public InputStream getEntityStream()

Return entity body represented by InputStream.

Returns:

the entity data stream.

getResourceIdentifier

public ResourceIdentifier getResourceIdentifier()

get ResourceIdentifier.

Returns:

the ResourceIdentifier.

See Also:

org.exoplatform.services.rest.ResourceIdentifier.

setResourceIdentifier

public void setResourceIdentifier(ResourceIdentifier resourceIdentifier)

set ResourceIdentifier.

Parameters:

resourceIdentifier - the ResourceIdentifier.

See Also:

org.exoplatform.services.rest.ResourceIdentifier.

getMethodName

public String getMethodName()

HTTP method name.

Returns:

the HTTP method name.

getHeaderParams

public MultivaluedMetadata getHeaderParams()

Return a map of key-values pair of header parameters.

Returns:

the all key-values pair of headers

See Also:

org.exoplatform.services.rest.MultivaluedMetadata.

getQueryParams

public MultivaluedMetadata getQueryParams()

Return a map of key-values pair of query parameters.

Returns:

the all key-values pair of query parameters.

See Also:

org.exoplatform.services.rest.MultivaluedMetadata.

getCookie

public Cookie getCookie(String name)

Parameters:

name - the cookie name.

Returns:

the map of cookies, key is cookie name.