com.gwtplatform.dispatch.rest.client

Class AbstractRestAction<R>

java.lang.Object

com.gwtplatform.dispatch.rest.client.AbstractRestAction<R>

Type Parameters:

R - the result type

All Implemented Interfaces:

RestAction<R>, HasSecured, TypedAction<R>

public abstract class AbstractRestAction<R>
extends Object
implements RestAction<R>

Provides a basic implementation of RestAction to inheritors. This is used by GWTP code-generator to create the actions defined by the RestService implementers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRestAction()
protected	AbstractRestAction(HttpMethod httpMethod, String rawServicePath, String defaultDateFormat)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addFormParam(String name, Date date)
protected void	addFormParam(String name, Date date, String pattern)
protected void	addFormParam(String name, Object value)
protected void	addHeaderParam(String name, Date date)
protected void	addHeaderParam(String name, Date date, String pattern)
protected void	addHeaderParam(String name, Object value)
protected void	addPathParam(String name, Date date)
protected void	addPathParam(String name, Date date, String pattern)
protected void	addPathParam(String name, Object value)
protected void	addQueryParam(String name, Date date)
protected void	addQueryParam(String name, Date date, String pattern)
protected void	addQueryParam(String name, Object value)
Object	getBodyParam()
List<RestParameter>	getFormParams()
List<RestParameter>	getHeaderParams()
HttpMethod	getHttpMethod()
String	getPath() Returns the relative path for this action.
List<RestParameter>	getPathParams()
List<RestParameter>	getQueryParams()
Boolean	hasBodyParam() Verify if this action a body object.
Boolean	hasFormParams() Verify if this action contains FORM parameters.
protected void	setBodyParam(Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gwtplatform.dispatch.shared.HasSecured

isSecured

Constructor Detail

AbstractRestAction

protected AbstractRestAction()

AbstractRestAction

protected AbstractRestAction(HttpMethod httpMethod,
                  String rawServicePath,
                  String defaultDateFormat)

Method Detail

getHttpMethod

public HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface RestAction<R>

Returns:

the HttpMethod used to send this action over HTTP.

getPath

public String getPath()

Description copied from interface: RestAction

Returns the relative path for this action. It should not be prepended by the path annotated with @RestApplicationPath.

Specified by:

getPath in interface RestAction<R>

Returns:

the relative path for this action.

getPathParams

public List<RestParameter> getPathParams()

Specified by:

getPathParams in interface RestAction<R>

Returns:

a List of the @Path parameters for this action.

getQueryParams

public List<RestParameter> getQueryParams()

Specified by:

getQueryParams in interface RestAction<R>

Returns:

a List of the @QueryParam parameters for this action.

getFormParams

public List<RestParameter> getFormParams()

Specified by:

getFormParams in interface RestAction<R>

Returns:

a List of the @FormParam parameters for this action. RestAction.getBodyParam() should return null.

getHeaderParams

public List<RestParameter> getHeaderParams()

Specified by:

getHeaderParams in interface RestAction<R>

Returns:

a List of the @HeaderParam parameters for this action.

getBodyParam

public Object getBodyParam()

Specified by:

getBodyParam in interface RestAction<R>

Returns:

The object that will be serialized and used for the body of this action. RestAction.getFormParams() should return an empty list.

hasFormParams

public Boolean hasFormParams()

Description copied from interface: RestAction

Verify if this action contains FORM parameters. RestAction.hasBodyParam() should return false.

Specified by:

hasFormParams in interface RestAction<R>

Returns:

true if this method contains form parameters, otherwise false.

hasBodyParam

public Boolean hasBodyParam()

Description copied from interface: RestAction

Verify if this action a body object. RestAction.hasFormParams() should return false.

Specified by:

hasBodyParam in interface RestAction<R>

Returns:

true if this method contains body object, otherwise false.

addPathParam

protected void addPathParam(String name,
                Object value)

addPathParam

protected void addPathParam(String name,
                Date date)

addPathParam

protected void addPathParam(String name,
                Date date,
                String pattern)

addQueryParam

protected void addQueryParam(String name,
                 Object value)

addQueryParam

protected void addQueryParam(String name,
                 Date date)

addQueryParam

protected void addQueryParam(String name,
                 Date date,
                 String pattern)

addFormParam

protected void addFormParam(String name,
                Object value)

addFormParam

protected void addFormParam(String name,
                Date date)

addFormParam

protected void addFormParam(String name,
                Date date,
                String pattern)

addHeaderParam

protected void addHeaderParam(String name,
                  Object value)

addHeaderParam

protected void addHeaderParam(String name,
                  Date date)

addHeaderParam

protected void addHeaderParam(String name,
                  Date date,
                  String pattern)

setBodyParam

protected void setBodyParam(Object value)