com.gwtplatform.dispatch.rpc.shared

Interface Action<R extends Result>

Type Parameters:

R - The Result type.

All Superinterfaces:

HasSecured, IsSerializable, TypedAction<R>

All Known Implementing Classes:

ActionImpl, BatchAction, TestAction, UnsecuredActionImpl

public interface Action<R extends Result>
extends TypedAction<R>, HasSecured, IsSerializable

An action represents a command sent to the Dispatch. It has a specific result type which is returned if the action is successful. Your implementation should override getServiceName() to return a default service url. If you use a SecurityCookie to prevent XSRF attacks and you want this action to be secured against such attacks (i.e. it's not meant to be an anonymous action) then you should override HasSecured.isSecured() to return true.

You can usually inherit from ActionImpl or UnsecuredActionImpl instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME The URL of the service used by default.

Method Summary

Methods

Modifier and Type	Method and Description
String	getServiceName() Access the name of the service, which will be used as the URL path to access the action.

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

isSecured

Field Detail

DEFAULT_SERVICE_NAME

static final String DEFAULT_SERVICE_NAME

The URL of the service used by default.

See Also:

Constant Field Values

Method Detail

getServiceName

String getServiceName()

Access the name of the service, which will be used as the URL path to access the action.

Returns:

The service name.