Package si.mazi.rescu

Class RestInvocation

java.lang.Object

si.mazi.rescu.RestInvocation

All Implemented Interfaces:

Serializable

public class RestInvocation
extends Object
implements Serializable

This holds name-value mapping for various types of params used in REST (QueryParam, PathParam, FormParam, HeaderParam). One RestInvocation instance corresponds to one method invocation.

Author:

Matija Mazi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static List<Class<? extends Annotation>>	PARAM_ANNOTATION_CLASSES

Method Summary

Modifier and Type	Method	Description
static RestInvocation	create(RequestWriterResolver requestWriterResolver, RestMethodMetadata methodMetadata, Object[] args, Map<Class<? extends Annotation>,Params> defaultParamsMap)
static HashMap<Class<? extends Annotation>,Params>	createEmptyParamsMap(Map<Class<? extends Annotation>,Params> defaultParamsMap)
Map<String,String>	getAllHttpHeaders()	Deprecated. this method will be made package local very soon.
String	getBaseUrl()
Map<String,String>	getHttpHeadersFromParams()
String	getHttpMethod()
String	getInvocationUrl()
RestMethodMetadata	getMethodMetadata()
String	getMethodPath()
Map<Class<? extends Annotation>,Params>	getParamsMap()
Object	getParamValue(Class<? extends Annotation> paramAnnotation, String paramName)
String	getPath()
String	getQueryString()
String	getReqContentType()
String	getRequestBody()
List<Object>	getUnannanotatedParams()

Methods inherited from class java.lang.Object

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

Field Details

PARAM_ANNOTATION_CLASSES

protected static final List<Class<? extends Annotation>> PARAM_ANNOTATION_CLASSES

Method Details

create

public static RestInvocation create(RequestWriterResolver requestWriterResolver, RestMethodMetadata methodMetadata, Object[] args, Map<Class<? extends Annotation>,Params> defaultParamsMap)

createEmptyParamsMap

public static HashMap<Class<? extends Annotation>,Params> createEmptyParamsMap(Map<Class<? extends Annotation>,Params> defaultParamsMap)

getRequestBody

public String getRequestBody()

getAllHttpHeaders

@Deprecated public Map<String,String> getAllHttpHeaders()

Deprecated.

this method will be made package local very soon. Use getHttpHeadersFromParams() instead.

Returns:

getHttpHeadersFromParams

public Map<String,String> getHttpHeadersFromParams()

getReqContentType

public String getReqContentType()

getInvocationUrl

public String getInvocationUrl()

Returns:

The invocation url that is used in this invocation.

getMethodPath

public String getMethodPath()

Returns:

The part of the url path that corresponds to the method.

getPath

public String getPath()

Returns:

The whole url path: the interface path together with the method path. This is usally the part of the url that follows the host name.

getBaseUrl

public String getBaseUrl()

Returns:

The base of the url: this usually contains the protocol (eg. http) and the host name (eg. http://www.example.com/) but may be longer.

getQueryString

public String getQueryString()

Returns:

The part of the invocation url that follows the '?' charater, ie. the &-separated name=value parameter pairs.

getHttpMethod

public String getHttpMethod()

Returns:

The HTTP method used in this invocation e.g. GET or POST

getMethodMetadata

public RestMethodMetadata getMethodMetadata()

getParamValue

public Object getParamValue(Class<? extends Annotation> paramAnnotation, String paramName)

Parameters:

paramAnnotation - One of QueryParam.class, PathParam.class, FormParam.class, HeaderParam.class

paramName - The name of the parameter, ie. the value of the value() element in the annotation.

Returns:

The actual value that was passed as the argument in the method call; null if either no parameter with the given name exists or null was passed as argument.

getParamsMap

public Map<Class<? extends Annotation>,Params> getParamsMap()

Returns:

the paramsMap

getUnannanotatedParams

public List<Object> getUnannanotatedParams()

Returns:

the unannanotatedParams