co.codewizards.cloudstore.ls.rest.server

Class InverseInvoker

java.lang.Object

co.codewizards.cloudstore.ls.rest.server.InverseInvoker

All Implemented Interfaces:

Invoker

public class InverseInvoker
extends Object
implements Invoker

Method Summary

Modifier and Type	Method and Description
void	decRefCount(ObjectRef objectRef, Uid refId)
ClassInfoMap	getClassInfoMap()
static InverseInvoker	getInverseInvoker(ObjectManager objectManager)
ObjectManager	getObjectManager()
Object	getRemoteObjectProxyOrCreate(ObjectRef objectRef)
void	incRefCount(ObjectRef objectRef, Uid refId)
<T> T	invoke(Object object, String methodName, Class<?>[] argumentTypes, Object... arguments)
<T> T	invoke(Object object, String methodName, Object... arguments)
<T> T	invoke(Object object, String methodName, String[] argumentTypeNames, Object... arguments) Invoke a method on the given objectRef (which is a proxy) in the LocalServer or in its client (from the respective other side).
<T> T	invokeConstructor(Class<T> clazz, Class<?>[] argumentTypes, Object... arguments)
<T> T	invokeConstructor(Class<T> clazz, Object... arguments) Invoke a constructor from the LocalServerClient in the LocalServer or vice-versa.
<T> T	invokeConstructor(String className, Object... arguments) Invoke a constructor from the LocalServerClient in the LocalServer or vice-versa.
<T> T	invokeConstructor(String className, String[] argumentTypeNames, Object... arguments)
<T> T	invokeStatic(Class<?> clazz, String methodName, Class<?>[] argumentTypes, Object... arguments) Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.
<T> T	invokeStatic(Class<?> clazz, String methodName, Object... arguments) Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.
<T> T	invokeStatic(String className, String methodName, Object... arguments) Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.
<T> T	invokeStatic(String className, String methodName, String[] argumentTypeNames, Object... arguments) Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.
<T extends InverseServiceResponse> T	performInverseServiceRequest(InverseServiceRequest request) Invokes a service on the client-side.
InverseServiceRequest	pollInverseServiceRequest()
void	pushInverseServiceResponse(InverseServiceResponse response)

Methods inherited from class java.lang.Object

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

Method Detail

getInverseInvoker

public static InverseInvoker getInverseInvoker(ObjectManager objectManager)

getObjectManager

public ObjectManager getObjectManager()

Specified by:

getObjectManager in interface Invoker

invokeStatic

public <T> T invokeStatic(Class<?> clazz,
                          String methodName,
                          Object... arguments)

Description copied from interface: Invoker

Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.

Convenience method delegating to Invoker.invokeStatic(String, String, String[], Object...).

See Invoker.invoke(Object, String, String[], Object...) for further details.

Specified by:

invokeStatic in interface Invoker

Parameters:

clazz - the class owning the static method to be invoked. Must not be null.

methodName - the name of the static method to be invoked. Must not be null.

arguments - the arguments passed to the static method. May be null (if the method does not take any parameters).

Returns:

the result of the method invocation. May be null.

See Also:

Invoker.invokeStatic(String, String, String[], Object...), Invoker.invoke(Object, String, String[], Object...)

invokeStatic

public <T> T invokeStatic(String className,
                          String methodName,
                          Object... arguments)

Description copied from interface: Invoker

Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.

Convenience method delegating to Invoker.invokeStatic(String, String, String[], Object...).

See Invoker.invoke(Object, String, String[], Object...) for further details.

Specified by:

invokeStatic in interface Invoker

Parameters:

className - the fully qualified name of the class owning the static method to be invoked. Must not be null.

methodName - the name of the static method to be invoked. Must not be null.

arguments - the arguments passed to the static method. May be null (if the method does not take any parameters).

Returns:

the result of the method invocation. May be null.

See Also:

Invoker.invokeStatic(String, String, String[], Object...), Invoker.invoke(Object, String, String[], Object...)

invokeStatic

public <T> T invokeStatic(Class<?> clazz,
                          String methodName,
                          Class<?>[] argumentTypes,
                          Object... arguments)

Description copied from interface: Invoker

Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.

Convenience method delegating to Invoker.invokeStatic(String, String, String[], Object...).

See Invoker.invoke(Object, String, String[], Object...) for further details.

Specified by:

invokeStatic in interface Invoker

Parameters:

clazz - the class owning the static method to be invoked. Must not be null.

methodName - the name of the static method to be invoked. Must not be null.

argumentTypes - the argument-types. May be null; then a matching method will be searched. If there are multiple matching methods, an exception is thrown, though (and the argument-types must be specified). If argumentTypes is not null, its length must match the one of arguments.

arguments - the arguments passed to the static method. May be null (if the method does not take any parameters).

Returns:

the result of the method invocation. May be null.

See Also:

Invoker.invokeStatic(String, String, String[], Object...), Invoker.invoke(Object, String, String[], Object...)

invokeStatic

public <T> T invokeStatic(String className,
                          String methodName,
                          String[] argumentTypeNames,
                          Object... arguments)

Description copied from interface: Invoker

Invoke a static method from the LocalServerClient in the LocalServer or vice-versa.

See Invoker.invoke(Object, String, String[], Object...) for further details.

Specified by:

invokeStatic in interface Invoker

Parameters:

className - the fully qualified name of the class owning the static method to be invoked. Must not be null.

methodName - the name of the static method to be invoked. Must not be null.

argumentTypeNames - the fully qualified names of the argument-types. May be null; then a matching method will be searched. If there are multiple matching methods, an exception is thrown, though (and the argument-types must be specified). If argumentTypeNames is not null, its length must match the one of arguments.

arguments - the arguments passed to the static method. May be null (if the method does not take any parameters).

Returns:

the result of the method invocation. May be null.

See Also:

Invoker.invoke(Object, String, String[], Object...)

invokeConstructor

public <T> T invokeConstructor(Class<T> clazz,
                               Object... arguments)

Description copied from interface: Invoker

Invoke a constructor from the LocalServerClient in the LocalServer or vice-versa.

Convenience method delegating to Invoker.invokeConstructor(String, String[], Object...).

See Invoker.invoke(Object, String, String[], Object...) for further details.

Specified by:

invokeConstructor in interface Invoker

Parameters:

clazz - the class to be instantiated. Must not be null.

arguments - the arguments passed to the constructor. May be null (if the constructor does not take any parameters).

Returns:

the newly created objectRef. Never null.

See Also:

Invoker.invokeConstructor(String, String[], Object...), Invoker.invoke(Object, String, String[], Object...)

invokeConstructor

public <T> T invokeConstructor(String className,
                               Object... arguments)

Description copied from interface: Invoker

Invoke a constructor from the LocalServerClient in the LocalServer or vice-versa.

See Invoker.invoke(Object, String, String[], Object...) for further details.

Specified by:

invokeConstructor in interface Invoker

Parameters:

className - the fully qualified name of the class to be instantiated. Must not be null.

arguments - the arguments passed to the constructor. May be null (if the constructor does not take any parameters).

Returns:

the newly created objectRef. Never null.

See Also:

Invoker.invokeConstructor(String, String[], Object...), Invoker.invoke(Object, String, String[], Object...)

invokeConstructor

public <T> T invokeConstructor(Class<T> clazz,
                               Class<?>[] argumentTypes,
                               Object... arguments)

Specified by:

invokeConstructor in interface Invoker

invokeConstructor

public <T> T invokeConstructor(String className,
                               String[] argumentTypeNames,
                               Object... arguments)

Specified by:

invokeConstructor in interface Invoker

invoke

public <T> T invoke(Object object,
                    String methodName,
                    Object... arguments)

Specified by:

invoke in interface Invoker

invoke

public <T> T invoke(Object object,
                    String methodName,
                    Class<?>[] argumentTypes,
                    Object... arguments)

Specified by:

invoke in interface Invoker

invoke

public <T> T invoke(Object object,
                    String methodName,
                    String[] argumentTypeNames,
                    Object... arguments)

Description copied from interface: Invoker

Invoke a method on the given objectRef (which is a proxy) in the LocalServer or in its client (from the respective other side).

The LocalServer might reside in the same JVM or in a separate JVM (on the same computer, hence "local").

When invoking a method, the arguments must be passed to the real objectRef on the other side (in the other JVM). Therefore, all primitives (byte, long etc.) as well as all objects implementing Serializable are serialized (via Java native serialisation), transmitted via a REST call and deserialized.

If, however, an objectRef passed as an argument is a proxy of a real objectRef in the server (no matter, if it implements Serializable or not), it is converted into an Object instead - and this reference is transmitted via REST. The server then resolves the Object to the real objectRef.

If an objectRef in the arguments is neither a proxy of a LocalServer-objectRef (it may be a proxy of sth. else) nor implements Serializable, instead a reverse-proxy is created on the server-side. Therefore, an Object in the local JVM is created and passed via REST. The server then determines all interfaces of the real objectRef and instantiates a proxy (or re-uses an already existing one). This reverse-proxy-mechanism allows for passing a listener, e.g. a PropertyChangeListener: If the server invokes a method on the reverse-proxy, the InverseInvoker is used to invoke the corresponding method on the real objectRef in the client-JVM.

Important: For the proxies (both the ones on the client-side and the reverse-ones on the server-side), the standard Java Proxy is used. Therefore, only interfaces can be proxied - no classes. We cannot use cglib or any other more advanced proxy-lib, because these libs cannot be used with Android.

However, if a method declared by a class and not an interface should be invoked, this can still be done via this method - it's just less convenient. Additionally, reverse-proxies (on the server-side) obviously can only be passed to the real objectRef's method, if the method-signature uses an interface (or Object) for the argument in question.

Specified by:

invoke in interface Invoker

Parameters:

object - the proxy on which to invoke a method. Must not be null. This proxy was returned by a previous invocation of one of the invoke* methods (which might have happened indirectly via an invocation of a proxy's method).

methodName - the name of the method to be invoked. Must not be null.

argumentTypeNames - the fully qualified names of the argument-types. May be null; then a matching method will be searched. If there are multiple matching methods, an exception is thrown, though (and the argument-types must be specified). If argumentTypeNames is not null, its length must match the one of arguments.

arguments - the arguments passed to the method. May be null (if the method does not take any parameters).

Returns:

the result of the method invocation. This is either a serialized and deserialized "simple" objectRef or a proxy for a more complex objectRef on the server-side.

incRefCount

public void incRefCount(ObjectRef objectRef,
                        Uid refId)

Specified by:

incRefCount in interface Invoker

decRefCount

public void decRefCount(ObjectRef objectRef,
                        Uid refId)

Specified by:

decRefCount in interface Invoker

getRemoteObjectProxyOrCreate

public Object getRemoteObjectProxyOrCreate(ObjectRef objectRef)

performInverseServiceRequest

public <T extends InverseServiceResponse> T performInverseServiceRequest(InverseServiceRequest request)
                                                                  throws TimeoutException

Invokes a service on the client-side.

Normally, a client initiates a request-response-cycle by sending a request to a server-side service and waiting for the response. In order to notify client-side listeners, we need the inverse, though: the server must invoke a service on the client-side. This can be easily done by sending an implementation of InverseServiceRequest to a InverseServiceRequestHandler implementation on the client-side using this method.

Parameters:

request - the request to be processed on the client-side. Must not be null.

Returns:

the response created and sent back by the client-side InverseServiceRequestHandler.

Throws:

TimeoutException - if this method did not receive a response within the timeout PERFORM_INVERSE_SERVICE_REQUEST_TIMEOUT_MS.

pollInverseServiceRequest

public InverseServiceRequest pollInverseServiceRequest()

pushInverseServiceResponse

public void pushInverseServiceResponse(InverseServiceResponse response)

getClassInfoMap

public ClassInfoMap getClassInfoMap()

Specified by:

getClassInfoMap in interface Invoker