org.granite.client.tide.impl

Class ComponentImpl

java.lang.Object

org.granite.client.tide.impl.ComponentImpl

All Implemented Interfaces:

java.lang.reflect.InvocationHandler, ContextAware, NameAware, Component

Direct Known Subclasses:

BaseIdentity

public class ComponentImpl
extends java.lang.Object
implements Component, ContextAware, NameAware, java.lang.reflect.InvocationHandler

Default implementation of remote component proxy Generated typesafe remote service proxies should extend this class Component proxies are meant to be defined in a DI container (Spring/CDI) or directly in the Tide context

 Component myComponent = tideContext.set("myComponent", new ComponentImpl(serverSession));
 myComponent.call("myMethod", arg1, arg2);
 
 

Author:

William DRAI

Constructor Summary

Constructors

Constructor and Description
ComponentImpl() Default constructor necessary for testing and CDI proxying...
ComponentImpl(ServerSession serverSession) Create a new proxy attached to the specified server session

Method Summary

Methods

Modifier and Type	Method and Description
<T> java.util.concurrent.Future<T>	call(java.lang.String operation, java.lang.Object... args) Call a remote operation on the component
protected <T> java.util.concurrent.Future<T>	callComponent(Context context, java.lang.String operation, java.lang.Object[] args) Calls a remote component
protected Context	getContext() Context where the component is set
java.lang.String	getName() Remote name of the component
protected ServerSession	getServerSession() Server session to which the component is attached
protected <T> java.util.concurrent.Future<T>	invoke(Context context, java.lang.String operation, java.lang.Object[] args, TideResponder<T> tideResponder) Execute the invocation of the remote component
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
<T> TideResultEvent<T>	newResultEvent(T result) Create a result event for this component
void	setContext(Context context) Set the context where the component is set
void	setName(java.lang.String name) Set the remote name of the component By default the component will use its name in its owning context as the remote name

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentImpl

public ComponentImpl()

Default constructor necessary for testing and CDI proxying...

ComponentImpl

public ComponentImpl(ServerSession serverSession)

Create a new proxy attached to the specified server session

Parameters:

serverSession - server session

Method Detail

setName

public void setName(java.lang.String name)

Set the remote name of the component By default the component will use its name in its owning context as the remote name

Specified by:

setName in interface NameAware

Parameters:

name - name

getName

public java.lang.String getName()

Remote name of the component

Specified by:

getName in interface Component

Returns:

name

setContext

public void setContext(Context context)

Set the context where the component is set

Specified by:

setContext in interface ContextAware

Parameters:

context - Tide context

getContext

protected Context getContext()

Context where the component is set

Returns:

Tide context

getServerSession

protected ServerSession getServerSession()

Server session to which the component is attached

Returns:

server session

call

public <T> java.util.concurrent.Future<T> call(java.lang.String operation,
                                      java.lang.Object... args)

Description copied from interface: Component

Call a remote operation on the component

Specified by:

call in interface Component

Type Parameters:

T - expected return type

Parameters:

operation - method name

args - arguments

Returns:

future triggered when response is received

invoke

public java.lang.Object invoke(java.lang.Object proxy,
                      java.lang.reflect.Method method,
                      java.lang.Object[] args)
                        throws java.lang.Throwable

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

java.lang.Throwable

callComponent

protected <T> java.util.concurrent.Future<T> callComponent(Context context,
                                               java.lang.String operation,
                                               java.lang.Object[] args)

Calls a remote component

Parameters:

context - the source context

operation - name of the called metho

args - method arguments

Returns:

future returning the result of the call

invoke

protected <T> java.util.concurrent.Future<T> invoke(Context context,
                                        java.lang.String operation,
                                        java.lang.Object[] args,
                                        TideResponder<T> tideResponder)

Execute the invocation of the remote component

Type Parameters:

T - expected type of result

Parameters:

context - the source context

operation - method name

args - method arguments

tideResponder - Tide responder for the remote call

Returns:

future triggered asynchronously when response is received

newResultEvent

public <T> TideResultEvent<T> newResultEvent(T result)

Create a result event for this component

Type Parameters:

T - expected type of the result

Parameters:

result - result to wrap in an event

Returns:

result event