com.gwtplatform.dispatch.client

Class DispatchCall<A extends TypedAction<R>,R>

java.lang.Object

com.gwtplatform.dispatch.client.DispatchCall<A,R>

Type Parameters:

A - The type of the TypedAction wrapped by this DispatchCall.

R - The type of the result of the wrapped TypedAction.

Direct Known Subclasses:

RestDispatchCall, RpcDispatchExecuteCall, RpcDispatchUndoCall

public abstract class DispatchCall<A extends TypedAction<R>,R>
extends Object

An class representing a call made to the server through RestDispatch or DispatchAsync.

This class will perform the work shared by all dispatch modules. It will delegate exceptions to the bound ExceptionHandler. It will provide access to the security cookie through the bound SecurityCookieAccessor. It will also delegate calls to the bound ClientActionHandlerRegistry.

It also provides a couple extension points for implementations.

Constructor Summary

Constructors

Constructor and Description
DispatchCall(ExceptionHandler exceptionHandler, ClientActionHandlerRegistry clientActionHandlerRegistry, SecurityCookieAccessor securityCookieAccessor, DispatchHooks dispatchHooks, A action, AsyncCallback<R> callback)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract DispatchRequest	doExecute() Implementations must override this method to perform additional work when execute() is called.
DispatchRequest	execute() Call this method to execute the action wrapped by this instance.
protected A	getAction() Returns the TypedAction wrapped by this DispatchCall.
protected AsyncCallback<R>	getCallback() The AsyncCallback to use when the execution of the action wrapped by this object is completed.
protected ClientActionHandlerRegistry	getClientActionHandlerRegistry() Returns the bound ClientActionHandlerRegistry.
protected ExceptionHandler	getExceptionHandler() Returns the bound ExceptionHandler.
protected String	getSecurityCookie() Returns the current security cookie as returned by the bound SecurityCookieAccessor.
protected SecurityCookieAccessor	getSecurityCookieAccessor() Returns the bound SecurityCookieAccessor.
protected void	onExecuteFailure(Throwable caught) Override this method to perform additional work when the action execution failed.
protected void	onExecuteFailure(Throwable caught, Response response) Override this method to perform additional work when the action execution failed.
protected void	onExecuteSuccess(R result) Override this method to perform additional work when the action execution succeeded.
protected void	onExecuteSuccess(R result, Response response) Override this method to perform additional work when the action execution succeeded.

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchCall

public DispatchCall(ExceptionHandler exceptionHandler,
            ClientActionHandlerRegistry clientActionHandlerRegistry,
            SecurityCookieAccessor securityCookieAccessor,
            DispatchHooks dispatchHooks,
            A action,
            AsyncCallback<R> callback)

Method Detail

execute

public DispatchRequest execute()

Call this method to execute the action wrapped by this instance. If the action is registered by the ClientActionHandlerRegistry, it will delegate the call it.

Implementations should consider overriding doExecute() to perform additional work.

Returns:

a DispatchRequest object.

doExecute

protected abstract DispatchRequest doExecute()

Implementations must override this method to perform additional work when execute() is called.

Returns:

a DispatchRequest object.

getAction

protected A getAction()

Returns the TypedAction wrapped by this DispatchCall.

Returns:

the TypedAction wrapped by this object.

getCallback

protected AsyncCallback<R> getCallback()

The AsyncCallback to use when the execution of the action wrapped by this object is completed.

Returns:

the AsyncCallback to call when the action has been executed.

getClientActionHandlerRegistry

protected ClientActionHandlerRegistry getClientActionHandlerRegistry()

Returns the bound ClientActionHandlerRegistry.

Returns:

the bound ClientActionHandlerRegistry.

getExceptionHandler

protected ExceptionHandler getExceptionHandler()

Returns the bound ExceptionHandler.

Returns:

the bound ExceptionHandler.

getSecurityCookieAccessor

protected SecurityCookieAccessor getSecurityCookieAccessor()

Returns the bound SecurityCookieAccessor.

Returns:

the bound SecurityCookieAccessor.

getSecurityCookie

protected String getSecurityCookie()

Returns the current security cookie as returned by the bound SecurityCookieAccessor.

Returns:

the current security cookie.

onExecuteSuccess

protected void onExecuteSuccess(R result)

Override this method to perform additional work when the action execution succeeded.

Parameters:

result - the action result.

onExecuteSuccess

protected void onExecuteSuccess(R result,
                    Response response)

Override this method to perform additional work when the action execution succeeded.

Parameters:

result - the action result.

response - the action Response.

onExecuteFailure

protected void onExecuteFailure(Throwable caught)

Override this method to perform additional work when the action execution failed.

Parameters:

caught - the caught Throwable.

onExecuteFailure

protected void onExecuteFailure(Throwable caught,
                    Response response)

Override this method to perform additional work when the action execution failed.

Parameters:

caught - the caught Throwable.

response - the failure Response.