com.gwtplatform.dispatch.rest.shared

Interface RestAction<R>

Type Parameters:

R - the result type.

All Superinterfaces:

HasSecured, TypedAction<R>

All Known Implementing Classes:

AbstractRestAction

public interface RestAction<R>
extends TypedAction<R>, HasSecured

An action used by RestDispatch.

You will usually want to let GWTP generate your actions by creating RestServices as explained here.

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

isSecured

Method Detail

getPath

String getPath()

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

Returns:

the relative path for this action.

getHttpMethod

HttpMethod getHttpMethod()

Returns:

the HttpMethod used to send this action over HTTP.

getPathParams

List<RestParameter> getPathParams()

Returns:

a List of the @Path parameters for this action.

getQueryParams

List<RestParameter> getQueryParams()

Returns:

a List of the @QueryParam parameters for this action.

getFormParams

List<RestParameter> getFormParams()

Returns:

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

getHeaderParams

List<RestParameter> getHeaderParams()

Returns:

a List of the @HeaderParam parameters for this action.

getBodyParam

Object getBodyParam()

Returns:

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

hasFormParams

Boolean hasFormParams()

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

Returns:

true if this method contains form parameters, otherwise false.

hasBodyParam

Boolean hasBodyParam()

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

Returns:

true if this method contains body object, otherwise false.