Package org.eclipse.ecf.remoteservice

Class AbstractRemoteService

    • Field Detail

      • EMPTY_ARGS

        protected static final java.lang.Object[] EMPTY_ARGS

      • futureExecutorServiceMaxThreads

        protected int futureExecutorServiceMaxThreads
        Since:
        8.2

      • futureExecutorService

        protected java.util.concurrent.ExecutorService futureExecutorService
        Since:
        8.2

      • iFutureExecutor

        protected org.eclipse.equinox.concurrent.future.IExecutor iFutureExecutor
        Since:
        8.2

    • Constructor Detail

      • AbstractRemoteService

        public AbstractRemoteService()

    • Method Detail

      • getFutureExecutorService

        protected java.util.concurrent.ExecutorService getFutureExecutorService​(IRemoteCall call)
        Parameters:
        call - the remote call to get the ExecutorService for
        Returns:
        ExecutorService
        Since:
        8.2

      • setFutureExecutorService

        protected void setFutureExecutorService​(java.util.concurrent.ExecutorService executorService)
        Parameters:
        executorService - the ExecutorService to use for this remote service
        Since:
        8.2

      • getIFutureExecutor

        protected org.eclipse.equinox.concurrent.future.IExecutor getIFutureExecutor​(IRemoteCall call)
        Parameters:
        call - the IRemoteCall to get the IExecutor for
        Returns:
        IExecutor the executor to use for the given call instance.
        Since:
        8.2

      • setIFutureExecutor

        protected void setIFutureExecutor​(org.eclipse.equinox.concurrent.future.IExecutor executor)
        Parameters:
        executor - executor
        Since:
        8.2

      • getInterfaceClassNames

        protected abstract java.lang.String[] getInterfaceClassNames()

      • loadInterfaceClass

        protected java.lang.Class loadInterfaceClass​(java.lang.String className)
                                      throws java.lang.ClassNotFoundException
        Throws:
        java.lang.ClassNotFoundException

      • loadInterfaceClass

        protected java.lang.Class loadInterfaceClass​(java.lang.ClassLoader cl,
                                             java.lang.String className)
                                      throws java.lang.ClassNotFoundException
        Parameters:
        cl - the ClassLoader to load the interface class. Will not be null
        className - the interface class to load
        Returns:
        Class the class loaded. Must not be null
        Throws:
        java.lang.ClassNotFoundException - if class cannot be found
        Since:
        6.0

      • getDefaultTimeout

        protected long getDefaultTimeout()

      • callAsync

        public org.eclipse.equinox.concurrent.future.IFuture callAsync​(IRemoteCall call)
        Description copied from interface: IRemoteService
        Call remote method specified by call parameter asynchronously, and immediately return IFuture instance. Returned IFuture will not be null, and allows the caller to retrieve the actual resulting value from the remote call (or exception).
        Specified by:
        callAsync in interface IRemoteService
        Parameters:
        call - the remote call to make. Must not be null .
        Returns:
        IFuture the asynchronous result to allow the caller to poll for whether the result IFuture.isDone(), and then to IFuture.get() the actual result.

      • getProxy

        public java.lang.Object getProxy()
                          throws ECFException
        Description copied from interface: IRemoteService
        Get local proxy for remote interface. The local proxy may then be used to make remote method calls transparently by invoking the local proxy method
        Specified by:
        getProxy in interface IRemoteService
        Returns:
        Object that implements the interface specified in the IRemoteServiceReference instance used to retrieve the IRemoteService object. The result may then be cast to the appropriate type. Will not be null.
        Throws:
        ECFException - If some problem in creating the proxy. The underlying problem is conveyed in the nested exception.

      • addRemoteServiceProxyToProxy

        protected void addRemoteServiceProxyToProxy​(java.util.List classes)
        Parameters:
        classes - the interface classes to add to
        Since:
        6.0

      • addAsyncProxyClasses

        protected java.util.List addAsyncProxyClasses​(java.lang.ClassLoader cl,
                                              java.lang.Class[] interfaces)
        Parameters:
        cl - ClassLoader to use to add async proxy classes
        interfaces - the Class[] of interface classes
        Returns:
        List the list of interfaces plus any async proxy interface classes.
        Since:
        8.3

      • getProxy

        public java.lang.Object getProxy​(java.lang.ClassLoader cl,
                                 java.lang.Class[] interfaces)
                          throws ECFException
        Description copied from interface: IRemoteService
        Get local proxy for remote interface. The local proxy may then be used to make remote method calls transparently by invoking the local proxy method
        Specified by:
        getProxy in interface IRemoteService
        Parameters:
        cl - ClassLoader to use to create the proxy class. Must not be null.
        interfaces - array of Class that has the loaded interface classes. Must not be null and should have dimension of one or more.
        Returns:
        Object that implements the given interfaceClasses. The result may then be cast to the one of the types given in interfaceClasses. Will not be null
        Throws:
        ECFException - If some problem in creating the proxy. The underlying problem is conveyed in the nested exception.
        Since:
        6.0

      • getRemoteServiceProxyCreator

        protected IRemoteServiceProxyCreator getRemoteServiceProxyCreator()
        Returns:
        IRemoteServiceProxyCreator
        Since:
        8.0

      • createProxy

        protected java.lang.Object createProxy​(java.lang.ClassLoader cl,
                                       java.lang.Class[] classes)
        Parameters:
        cl - ClassLoader for proxy creation
        classes - the Class[] for proxy classes
        Returns:
        Object the proxy implementing the given Class[]
        Since:
        6.0

      • createProxy

        protected java.lang.Object createProxy​(java.lang.Class[] classes)

      • findAsyncRemoteServiceProxyClass

        protected java.lang.Class findAsyncRemoteServiceProxyClass​(java.lang.Class c)
        Parameters:
        c - Class
        Returns:
        Class
        Since:
        3.3

      • findAsyncRemoteServiceProxyClass

        protected java.lang.Class findAsyncRemoteServiceProxyClass​(java.lang.ClassLoader cl,
                                                           java.lang.Class c)
        Parameters:
        cl - ClassLoader
        c - Class
        Returns:
        Class
        Since:
        6.0

      • convertInterfaceNameToAsyncInterfaceName

        protected java.lang.String convertInterfaceNameToAsyncInterfaceName​(java.lang.String interfaceName)

      • getCallParametersForProxyInvoke

        protected java.lang.Object[] getCallParametersForProxyInvoke​(java.lang.String callMethod,
                                                             java.lang.reflect.Method proxyMethod,
                                                             java.lang.Object[] args)

      • getCallTimeoutForProxyInvoke

        protected long getCallTimeoutForProxyInvoke​(java.lang.String callMethod,
                                            java.lang.reflect.Method proxyMethod,
                                            java.lang.Object[] args)

      • getCallMethodNameForProxyInvoke

        protected java.lang.String getCallMethodNameForProxyInvoke​(java.lang.reflect.Method method,
                                                           java.lang.Object[] args)

      • invokeObject

        protected java.lang.Object invokeObject​(java.lang.Object proxy,
                                        java.lang.reflect.Method method,
                                        java.lang.Object[] args)
                                 throws java.lang.Throwable
        Throws:
        java.lang.Throwable

      • isAsync

        protected boolean isAsync​(java.lang.Object proxy,
                          java.lang.reflect.Method method,
                          java.lang.Object[] args)
        Parameters:
        proxy - proxy instance
        method - the java Method invoked
        args - arguments
        Returns:
        true if given proxy/method/args combination represents an async proxy class
        Since:
        8.3

      • createRemoteCall

        protected IRemoteCall createRemoteCall​(java.lang.String callMethod,
                                       java.lang.Object[] callParameters,
                                       long callTimeout)
        Parameters:
        callMethod - call method
        callParameters - call parameters
        callTimeout - call timeout
        Returns:
        IRemoteCall remote call created. Should not be null
        Since:
        8.3

      • handleProxyException

        protected void handleProxyException​(java.lang.String message,
                                    java.lang.Throwable t)
                             throws ServiceException
        Parameters:
        message - message for exception
        t - Throwable to wrap
        Throws:
        ServiceException - thrown if subclasses do not override
        Since:
        8.6

      • handleInvokeSyncException

        protected void handleInvokeSyncException​(java.lang.String methodName,
                                         ECFException e)
                                  throws java.lang.Throwable
        Parameters:
        methodName - method name
        e - exception thrown if subclasses do not override
        Throws:
        java.lang.Throwable - thrown if subclasses to not override
        Since:
        8.6

      • invokeReturnAsync

        protected java.lang.Object invokeReturnAsync​(java.lang.Object proxy,
                                             java.lang.reflect.Method method,
                                             java.lang.Object[] args)
                                      throws java.lang.Throwable
        Throws:
        java.lang.Throwable
        Since:
        8.13

      • isOSGIAsync

        protected boolean isOSGIAsync()
        Since:
        8.13

      • isInterfaceAsync

        protected boolean isInterfaceAsync​(java.lang.Class interfaceClass)
        Since:
        8.13

      • isMethodAsync

        protected boolean isMethodAsync​(java.lang.String methodName)
        Since:
        8.13

      • 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

      • getAsyncRemoteCall

        protected RemoteCall getAsyncRemoteCall​(java.lang.String invokeMethodName,
                                        java.lang.Object[] asyncArgs)
        Parameters:
        invokeMethodName - invoke method name
        asyncArgs - asynch arguments
        Returns:
        RemoteCall remote call created. Should not be null
        Since:
        8.4

      • invokeAsync

        protected java.lang.Object invokeAsync​(java.lang.reflect.Method method,
                                       java.lang.Object[] args)
                                throws java.lang.Throwable
        Parameters:
        method - java Method invoked
        args - arguments
        Returns:
        Object async future result. Should be of type IFuture, Future, or CompletableFuture
        Throws:
        java.lang.Throwable - thrown if some problem invoking async
        Since:
        3.3

      • callAsyncWithResult

        protected java.lang.Object callAsyncWithResult​(IRemoteCall call,
                                               IRemoteCallListener listener)
        Parameters:
        call - remote call
        listener - remote call listener
        Returns:
        Object will be null unless subclasses override
        Since:
        8.2

      • callFutureAsync

        protected java.util.concurrent.Future callFutureAsync​(IRemoteCall call)
        Parameters:
        call - remote call
        Returns:
        Future future result
        Since:
        8.2

      • getAsyncArgs

        protected AbstractRemoteService.AsyncArgs getAsyncArgs​(java.lang.reflect.Method method,
                                                       java.lang.Object[] args)
        Parameters:
        method - method
        args - args
        Returns:
        AsyncArgs async arguments
        Since:
        3.3

      • getAsyncInvokeMethodName

        protected java.lang.String getAsyncInvokeMethodName​(java.lang.reflect.Method method)
        Parameters:
        method - java method invoked
        Returns:
        String synchronous method name without asynchronous suffix (i.e. fooAsync to foo)
        Since:
        3.3

      • logWarning

        protected void logWarning​(java.lang.String string,
                          java.lang.Throwable e)

      • callAsync

        public java.util.concurrent.Future<java.lang.Object> callAsync​(IRemoteCall call,
                                                               java.util.concurrent.Callable<java.lang.Object> callable)
        Since:
        8.13

      • callSync

        public java.lang.Object callSync​(IRemoteCall call,
                                 java.util.concurrent.Callable<java.lang.Object> callable)
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.ExecutionException,
                                 java.util.concurrent.TimeoutException
        Throws:
        java.util.concurrent.TimeoutException
        java.util.concurrent.ExecutionException
        java.lang.InterruptedException
        Since:
        8.13

      • dispose

        public void dispose()
        Since:
        8.2

      • callAsyncWithTimeout

        protected java.util.concurrent.Future<java.lang.Object> callAsyncWithTimeout​(IRemoteCall call,
                                                                             java.util.concurrent.Callable<java.lang.Object> callable)
        Since:
        8.13

      • createRCCE

        protected IRemoteCallCompleteEvent createRCCE​(java.lang.Object result,
                                              java.lang.Throwable e)
        Since:
        8.13