com.gwtplatform.tester

Class TestDispatchService

java.lang.Object

com.gwtplatform.tester.TestDispatchService

All Implemented Interfaces:

RemoteService, DispatchService

public class TestDispatchService
extends Object
implements DispatchService

This class is an implementation of DispatchService for use with test cases that configure guice using a MockHandlerModule.

Author:

Brendan Doherty

Constructor Summary

Constructors

Constructor and Description
TestDispatchService(Dispatch dispatch)

Method Summary

Methods

Modifier and Type	Method and Description
Result	execute(String cookieSentByRPC, Action<?> action) This method is called server-side whenever a new action is dispatched.
void	undo(String cookieSentByRPC, Action<Result> action, Result result) This method is called server-side whenever a previously executed action needs to be undone.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestDispatchService

@Inject
public TestDispatchService(Dispatch dispatch)

Method Detail

execute

public Result execute(String cookieSentByRPC,
             Action<?> action)
               throws ActionException,
                      ServiceException

Description copied from interface: DispatchService

This method is called server-side whenever a new action is dispatched.

Specified by:

execute in interface DispatchService

Parameters:

cookieSentByRPC - This is the content of the security cookie accessed on the client (in javascript), its goal is to prevent XSRF attacks. See SecurityCookieAccessor for more details.

action - The Action to execute.

Returns:

The Result of the action.

Throws:

ActionException - Thrown if the action could not be executed for application-specific reasons. User handlers should always throw ActionException or derived classes.

ServiceException - Thrown if the action could not be executed because of a service error.

See Also:

DispatchServiceAsync.execute(java.lang.String, com.gwtplatform.dispatch.rpc.shared.Action<?>, com.google.gwt.user.client.rpc.AsyncCallback<com.gwtplatform.dispatch.rpc.shared.Result>)

undo

public void undo(String cookieSentByRPC,
        Action<Result> action,
        Result result)
          throws ActionException,
                 ServiceException

Description copied from interface: DispatchService

This method is called server-side whenever a previously executed action needs to be undone.

Specified by:

undo in interface DispatchService

Parameters:

cookieSentByRPC - This is the content of the security cookie accessed on the client (in javascript), its goal is to prevent XSRF attacks. See SecurityCookieAccessor for more details.

action - The Action to execute.

result - The Result of this action when it was executed.

Throws:

ActionException - Thrown if the action could not be undone for application-specific reasons. User handlers should always throw ActionException or derived classes.

ServiceException - Thrown if the action could not be undone because of a service error.

See Also:

DispatchServiceAsync.undo(java.lang.String, com.gwtplatform.dispatch.rpc.shared.Action<?>, com.gwtplatform.dispatch.rpc.shared.Result, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void>)