com.google.gwt.user.client.rpc.impl

Class RemoteServiceProxy

java.lang.Object

com.google.gwt.user.client.rpc.impl.RemoteServiceProxy

All Implemented Interfaces:

HasRpcToken, SerializationStreamFactory, ServiceDefTarget

Direct Known Subclasses:

RpcServiceProxy

public abstract class RemoteServiceProxy
extends Object
implements SerializationStreamFactory, ServiceDefTarget, HasRpcToken

Superclass for client-side RemoteService proxies. For internal use only.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RemoteServiceProxy.ServiceHelper A helper class that prepares the service to serialize data.

Nested classes/interfaces inherited from interface com.google.gwt.user.client.rpc.ServiceDefTarget

ServiceDefTarget.NoServiceEntryPointSpecifiedException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteServiceProxy(String moduleBaseURL, String remoteServiceRelativePath, String serializationPolicyName, Serializer serializer)

Method Summary

Modifier and Type	Method and Description
static JavaScriptObject	bytesStat(String method, int count, int bytes, String eventType) Deprecated. use RpcStatsContext.
protected void	checkRpcTokenType(RpcToken token) This method is overridden by generated proxy classes to ensure that current service's RpcToken is of the type specified in RpcToken.RpcTokenImplementation annotation.
SerializationStreamReader	createStreamReader(String encoded) Returns a SerializationStreamReader that is ready for reading.
SerializationStreamWriter	createStreamWriter() Returns a SerializationStreamWriter that has had ClientSerializationStreamWriter.prepareToWrite() called on it and it has already had had the name of the remote service interface written as well.
protected <T> RequestCallback	doCreateRequestCallback(RequestCallbackAdapter.ResponseReader responseReader, String methodName, RpcStatsContext statsContext, AsyncCallback<T> callback)
protected <T> Request	doInvoke(RequestCallbackAdapter.ResponseReader responseReader, String methodName, RpcStatsContext statsContext, String requestData, AsyncCallback<T> callback) Performs a remote service method invocation.
protected <T> RequestBuilder	doPrepareRequestBuilder(RequestCallbackAdapter.ResponseReader responseReader, String methodName, RpcStatsContext statsContext, String requestData, AsyncCallback<T> callback) Configures a RequestBuilder to send an RPC request when the RequestBuilder is intended to be returned through the asynchronous proxy interface.
protected static int	getNextRequestId() Deprecated.
protected static int	getRequestId() Deprecated. Use RpcRequestBuilder instead.
RpcToken	getRpcToken() Return RPC token used with this RPC instance.
RpcTokenExceptionHandler	getRpcTokenExceptionHandler() Return RPC token exception handler used with this RPC instance.
String	getSerializationPolicyName() Return the strong name of the serialization policy to be used with this RPC instance.
String	getServiceEntryPoint() Gets the URL of a service implementation.
static boolean	isStatsAvailable() Deprecated. use RpcStatsContext.
void	setRpcRequestBuilder(RpcRequestBuilder builder) Sets the RpcRequestBuilder that should be used by the service implementation.
void	setRpcToken(RpcToken token) Sets the RpcToken to be included with each RPC call.
void	setRpcTokenExceptionHandler(RpcTokenExceptionHandler handler) Sets the handler for exceptions that occurred during RPC token processing.
void	setServiceEntryPoint(String url) Sets the URL of a service implementation.
static boolean	stats(JavaScriptObject data) Deprecated. use RpcStatsContext.
static JavaScriptObject	timeStat(String method, int count, String eventType) Deprecated. use RpcStatsContext.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

RemoteServiceProxy

protected RemoteServiceProxy(String moduleBaseURL,
                             String remoteServiceRelativePath,
                             String serializationPolicyName,
                             Serializer serializer)

Method Detail

bytesStat

@Deprecated
public static JavaScriptObject bytesStat(String method,
                                                     int count,
                                                     int bytes,
                                                     String eventType)

Deprecated. use RpcStatsContext.

isStatsAvailable

@Deprecated
public static boolean isStatsAvailable()

Deprecated. use RpcStatsContext.

Indicates if RPC statistics should be gathered.

stats

@Deprecated
public static boolean stats(JavaScriptObject data)

Deprecated. use RpcStatsContext.

Always use this as isStatsAvailable() && stats(JavaScriptObject).

timeStat

@Deprecated
public static JavaScriptObject timeStat(String method,
                                                    int count,
                                                    String eventType)

Deprecated. use RpcStatsContext.

getNextRequestId

@Deprecated
protected static int getNextRequestId()

Deprecated.

getRequestId

@Deprecated
protected static int getRequestId()

Deprecated. Use RpcRequestBuilder instead.

createStreamReader

public SerializationStreamReader createStreamReader(String encoded)
                                             throws SerializationException

Returns a SerializationStreamReader that is ready for reading.

Specified by:

createStreamReader in interface SerializationStreamFactory

Parameters:

encoded - string that encodes the response of an RPC request

Returns:

SerializationStreamReader that is ready for reading

Throws:

SerializationException

createStreamWriter

public SerializationStreamWriter createStreamWriter()

Returns a SerializationStreamWriter that has had ClientSerializationStreamWriter.prepareToWrite() called on it and it has already had had the name of the remote service interface written as well.

Specified by:

createStreamWriter in interface SerializationStreamFactory

Returns:

SerializationStreamWriter that has had ClientSerializationStreamWriter.prepareToWrite() called on it and it has already had had the name of the remote service interface written as well

getRpcToken

public RpcToken getRpcToken()

Description copied from interface: HasRpcToken

Return RPC token used with this RPC instance.

Specified by:

getRpcToken in interface HasRpcToken

Returns:

RPC token or null if none set.

See Also:

HasRpcToken.getRpcToken()

getRpcTokenExceptionHandler

public RpcTokenExceptionHandler getRpcTokenExceptionHandler()

Description copied from interface: HasRpcToken

Return RPC token exception handler used with this RPC instance.

Specified by:

getRpcTokenExceptionHandler in interface HasRpcToken

Returns:

Exception handler or null if none set.

See Also:

HasRpcToken.getRpcTokenExceptionHandler()

getSerializationPolicyName

public String getSerializationPolicyName()

Description copied from interface: ServiceDefTarget

Return the strong name of the serialization policy to be used with this RPC instance.

Specified by:

getSerializationPolicyName in interface ServiceDefTarget

getServiceEntryPoint

public String getServiceEntryPoint()

Description copied from interface: ServiceDefTarget

Gets the URL of a service implementation.

Specified by:

getServiceEntryPoint in interface ServiceDefTarget

Returns:

the last value passed to ServiceDefTarget.setServiceEntryPoint(String)

See Also:

ServiceDefTarget.getServiceEntryPoint()

setRpcRequestBuilder

public void setRpcRequestBuilder(RpcRequestBuilder builder)

Description copied from interface: ServiceDefTarget

Sets the RpcRequestBuilder that should be used by the service implementation. This method can be called if customized request behavior is desired. Calling this method with a null value will reset any custom behavior to the default implementation.

Specified by:

setRpcRequestBuilder in interface ServiceDefTarget

setRpcToken

public void setRpcToken(RpcToken token)

Description copied from interface: HasRpcToken

Sets the RpcToken to be included with each RPC call.

Specified by:

setRpcToken in interface HasRpcToken

See Also:

HasRpcToken.setRpcToken(RpcToken)

setRpcTokenExceptionHandler

public void setRpcTokenExceptionHandler(RpcTokenExceptionHandler handler)

Description copied from interface: HasRpcToken

Sets the handler for exceptions that occurred during RPC token processing.

Specified by:

setRpcTokenExceptionHandler in interface HasRpcToken

See Also:

HasRpcToken.setRpcTokenExceptionHandler(RpcTokenExceptionHandler)

setServiceEntryPoint

public void setServiceEntryPoint(String url)

Description copied from interface: ServiceDefTarget

Sets the URL of a service implementation.

Specified by:

setServiceEntryPoint in interface ServiceDefTarget

Parameters:

url - a URL that designates the service implementation to call

See Also:

ServiceDefTarget.setServiceEntryPoint(String)

checkRpcTokenType

protected void checkRpcTokenType(RpcToken token)

This method is overridden by generated proxy classes to ensure that current service's RpcToken is of the type specified in RpcToken.RpcTokenImplementation annotation.

Parameters:

token - currently set RpcToken.

doCreateRequestCallback

protected <T> RequestCallback doCreateRequestCallback(RequestCallbackAdapter.ResponseReader responseReader,
                                                      String methodName,
                                                      RpcStatsContext statsContext,
                                                      AsyncCallback<T> callback)

doInvoke

protected <T> Request doInvoke(RequestCallbackAdapter.ResponseReader responseReader,
                               String methodName,
                               RpcStatsContext statsContext,
                               String requestData,
                               AsyncCallback<T> callback)

Performs a remote service method invocation. This method is called by generated proxy classes.

Type Parameters:

T - return type for the AsyncCallback

Parameters:

responseReader - instance used to read the return value of the invocation

requestData - payload that encodes the addressing and arguments of the RPC call

callback - callback handler

Returns:

a Request object that can be used to track the request

doPrepareRequestBuilder

protected <T> RequestBuilder doPrepareRequestBuilder(RequestCallbackAdapter.ResponseReader responseReader,
                                                     String methodName,
                                                     RpcStatsContext statsContext,
                                                     String requestData,
                                                     AsyncCallback<T> callback)

Configures a RequestBuilder to send an RPC request when the RequestBuilder is intended to be returned through the asynchronous proxy interface.

Type Parameters:

T - return type for the AsyncCallback

Parameters:

responseReader - instance used to read the return value of the invocation

requestData - payload that encodes the addressing and arguments of the RPC call

callback - callback handler

Returns:

a RequestBuilder object that is ready to have its RequestBuilder.send() method invoked.