com.gwtplatform.dispatch.rpc.server

Class AbstractDispatchServiceImpl

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

com.gwtplatform.dispatch.rpc.server.AbstractDispatchServiceImpl

All Implemented Interfaces:

RemoteService, SerializationPolicyProvider, DispatchService, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

DispatchServiceImpl, DispatchServiceImpl

public abstract class AbstractDispatchServiceImpl
extends RemoteServiceServlet
implements DispatchService

This is the server-side implementation of the DispatchService, for which the client-side async service is DispatchServiceAsync.

This class is closely related to AbstractDispatchImpl, in theory the latter wouldn't be needed, but we use it to workaround a GWT limitation described in DispatchAsync.

See Also:

DispatchAsync, Dispatch, DispatchImpl, DispatchService, DispatchServiceAsync, DispatchServiceImpl, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Dispatch	dispatch
protected Logger	logger
protected RequestProvider	requestProvider

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDispatchServiceImpl(Logger logger, Dispatch dispatch, RequestProvider requestProvider)

Method Summary

Methods

Modifier and Type	Method and Description
Result	execute(String cookieSentByRPC, Action<?> action) ActionException and ServiceException will have their stacktraces (and stacktraces of their causes) removed for security purposes.
String	getSecurityCookieName()
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 com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, doGetSerializationPolicy, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, doUnexpectedFailure, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

dispatch

protected final Dispatch dispatch

logger

protected final Logger logger

requestProvider

protected RequestProvider requestProvider

Constructor Detail

AbstractDispatchServiceImpl

protected AbstractDispatchServiceImpl(Logger logger,
                           Dispatch dispatch,
                           RequestProvider requestProvider)

Method Detail

getSecurityCookieName

public String getSecurityCookieName()

execute

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

ActionException and ServiceException will have their stacktraces (and stacktraces of their causes) removed for security purposes.

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:

DispatchService for further API docs

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>)