org.clazzes.remoting.beans
Interface ReturnCallbackHandler

All Superinterfaces:
InvocationHandler
All Known Implementing Classes:
ReturnCallbackInvocationHandler

public interface ReturnCallbackHandler
extends InvocationHandler

A handler for calls to callback proxies returned by the server to the client.

Author:
wglas

Field Summary
static java.lang.String RETURN_PROXY_GUID_PROPERTY
          The property under which the GUID of the server-side proxy is stored in the invocation's request payload.
 
Method Summary
 int countCallbacks(java.rmi.server.UID sessionId)
          Count all callbacks of a given client.
 void deregisterAllCallbacks(java.rmi.server.UID sessionId)
          Deregister all callbacks of a given client.
 void deregisterCallback(java.rmi.server.UID sessionId, java.rmi.server.UID guid)
          Deregister a single callback of a given client.
 boolean isCallbackInterface(java.lang.Class<?> iface)
           
 java.rmi.server.UID registerCallback(java.rmi.server.UID sessionId, java.lang.Class<?> iface, java.lang.Object proxy)
           
 
Methods inherited from interface org.clazzes.remoting.InvocationHandler
invoke
 

Field Detail

RETURN_PROXY_GUID_PROPERTY

static final java.lang.String RETURN_PROXY_GUID_PROPERTY
The property under which the GUID of the server-side proxy is stored in the invocation's request payload.

See Also:
InvocationRequest#getRequestPayload(), Constant Field Values
Method Detail

isCallbackInterface

boolean isCallbackInterface(java.lang.Class<?> iface)
Parameters:
iface - The interface of a return value.
Returns:
Whether this interface is registered as a callback interface.

registerCallback

java.rmi.server.UID registerCallback(java.rmi.server.UID sessionId,
                                     java.lang.Class<?> iface,
                                     java.lang.Object proxy)
Parameters:
sessionId - A client session Id.
iface - The interface of a service return value.
proxy - The proxy object to be served.
Returns:
A UID for the registered proxy return value.

deregisterCallback

void deregisterCallback(java.rmi.server.UID sessionId,
                        java.rmi.server.UID guid)
Deregister a single callback of a given client.

Parameters:
sessionId - A client session Id.
guid - The GUID of the callback to be deregistered a returned by #registerCallback(String, Class, Object).

deregisterAllCallbacks

void deregisterAllCallbacks(java.rmi.server.UID sessionId)
Deregister all callbacks of a given client.

Parameters:
sessionId - A client session Id.

countCallbacks

int countCallbacks(java.rmi.server.UID sessionId)
Count all callbacks of a given client.

Parameters:
sessionId - A client session Id.
Returns:
The number of callbacks currently registered for the given client ID.


Copyright © 2010. All Rights Reserved.