Package org.eclipse.ecf.remoteservice

Class RemoteServiceContainerAdapterImpl

    • Constructor Detail

      • RemoteServiceContainerAdapterImpl

        public RemoteServiceContainerAdapterImpl​(IContainer container,
                                         org.eclipse.equinox.concurrent.future.IExecutor executor)

      • RemoteServiceContainerAdapterImpl

        public RemoteServiceContainerAdapterImpl​(IContainer container)

    • Method Detail

      • dispose

        public void dispose()

      • setRemoteServiceCallPolicy

        public boolean setRemoteServiceCallPolicy​(IRemoteServiceCallPolicy policy)
        Description copied from interface: IRemoteServiceContainerAdapter
        Set the remote service call policy to enable authorization on remote service method calls
        Specified by:
        setRemoteServiceCallPolicy in interface IRemoteServiceContainerAdapter
        Parameters:
        policy - Implementation of IRemoteServiceCallPolicy containing authorization specific code
        Returns:
        true if the underlying provider supports using the policy, false if it does not support using the policy.

      • getAdapter

        public Object getAdapter​(Class adapter)
        Specified by:
        getAdapter in interface org.eclipse.core.runtime.IAdaptable

      • registerRemoteService

        public IRemoteServiceRegistration registerRemoteService​(String[] clazzes,
                                                        Object service,
                                                        Dictionary properties)
        Description copied from interface: IRemoteServiceContainerAdapter
        Register a new remote service. This method is to be called by the service server...i.e. the client that wishes to make available a service to other client within this container.
        Specified by:
        registerRemoteService in interface IRemoteServiceContainerAdapter
        Specified by:
        registerRemoteService in interface IRemoteServiceHost
        Parameters:
        clazzes - the interface classes that the service exposes to remote clients. Must not be null and must not be an empty array.
        service - the service object. Under normal conditions this object must
        • not be null
        • implement all of the classes specified by the first parameter
        The only situation when the service object may be null is if the service property Constants.SERVICE_REGISTER_PROXY is set in the properties. If Constants.SERVICE_REGISTER_PROXY is set in the properties parameter (to an arbitrary value), then the service object may then be null.
        properties - to be associated with service
        Returns:
        IRemoteServiceRegistration the service registration. Will not return null .

      • getRemoteServiceReferences

        public IRemoteServiceReference[] getRemoteServiceReferences​(ID target,
                                                            ID[] idFilter,
                                                            String clazz,
                                                            String filter)
                                                     throws InvalidSyntaxException,
                                                            ContainerConnectException
        Description copied from interface: IRemoteServiceContainerAdapter
        Returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class and match the specified idFilter, and filter criteria.

        Note this method assumes that the enclosing container has previously been connected, and uses the idFilter to filter among targets within the previously connected set of container IDs. To request connection as part of reference lookup, see IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID, String, String).

        The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.

        target is a remote container to connect to. If null, no connection attempt is made.

        idFilter is used to select a registered services that were registered by a given set of containers with id in idFilter. Only services exposed by a container with id in idFilter will be returned. If idFilter is null, all containers are considered to match the filter.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax. If filter is null, all registered services are considered to match the filter. If filter cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

        Specified by:
        getRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        getRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        target - a target container to connect to if enclosing container is not already connected. May be null.
        idFilter - an array of ID instances that will restrict the search for matching container ids If null, all remote containers will be considered in search for matching IRemoteServiceReference instances. May be null.
        clazz - the fully qualified name of the interface class that describes the desired service. Must not be null.
        filter - The filter criteria. May be null.
        Returns:
        Array of IRemoteServiceReferences matching given search criteria or null if no services are found that match the search.
        Throws:
        InvalidSyntaxException - If filter contains an invalid filter string that cannot be parsed.
        ContainerConnectException - if container cannot connect

      • asyncGetRemoteServiceReferences

        public org.eclipse.equinox.concurrent.future.IFuture asyncGetRemoteServiceReferences​(ID target,
                                                                                     ID[] idFilter,
                                                                                     String clazz,
                                                                                     String filter)
        Description copied from interface: IRemoteServiceContainerAdapter
        Asynchronously returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class and match the specified idFilter, and filter criteria.

        The IFuture is returned immediately, and subsequent calls to IFuture.get() or IFuture.get(long) will return the actual results received. The type of the Object returned from IFuture.get() will be IRemoteServiceReference [].

        The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.

        target is a remote container to connect to. If null, no connection attempt is made.

        idFilter is used to select a registered services that were registered by a given set of containers with id in idFilter. Only services exposed by a container with id in idFilter will be returned. If idFilter is null, all containers are considered to match the filter.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax. If filter is null, all registered services are considered to match the filter. If filter cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

        Specified by:
        asyncGetRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        asyncGetRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        target - an target to connect to if enclosing container is not already connected. May be null.
        idFilter - an array of ID instances that will restrict the search for matching container ids If null, all remote containers will be considered in search for matching IRemoteServiceReference instances. May be null.
        clazz - the fully qualified name of the interface class that describes the desired service. Must not be null.
        filter - The filter criteria. May be null.
        Returns:
        IFuture that through subsequent calls to IFuture#get() will return IRemoteServiceReference [] with IRemoteServiceReferences matching given search criteria. Will not return null.

      • getRemoteServiceReferences

        public IRemoteServiceReference[] getRemoteServiceReferences​(ID[] idFilter,
                                                            String clazz,
                                                            String filter)
                                                     throws InvalidSyntaxException
        Description copied from interface: IRemoteServiceContainerAdapter
        Returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class and match the specified idFilter, and filter criteria.

        Note this method assumes that the enclosing container has previously been connected, and uses the idFilter to filter among targets within the previously connected set of container IDs. To request connection as part of reference lookup, see IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID, String, String).

        The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.

        idFilter is used to select a registered services that were registered by a given set of containers with id in idFilter. Only services exposed by a container with id in idFilter will be returned.

        If idFilter is null, all containers are considered to match the filter.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax.

        If filter is null, all registered services are considered to match the filter. If filter cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

        Specified by:
        getRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        getRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        idFilter - an array of ID instances that will restrict the search for matching container ids If null, all remote containers will be considered in search for matching IRemoteServiceReference instances. May be null.
        clazz - the fully qualified name of the interface class that describes the desired service. Must not be null.
        filter - The filter criteria. May be null.
        Returns:
        Array of IRemoteServiceReferences matching given search criteria or null if no services are found that match the search.
        Throws:
        InvalidSyntaxException - If filter contains an invalid filter string that cannot be parsed.

      • getRemoteServiceReferences

        public IRemoteServiceReference[] getRemoteServiceReferences​(ID target,
                                                            String clazz,
                                                            String filter)
                                                     throws InvalidSyntaxException,
                                                            ContainerConnectException
        Description copied from interface: IRemoteServiceContainerAdapter

        Returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class and match the specified idFilter, and filter criteria.

        The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.

        target is a remote container to connect to.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax.

        If filter is null, all registered services are considered to match the filter. If filter cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

        Specified by:
        getRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        getRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        target - an target to connect to if enclosing container is not already connected. May be null.
        clazz - the fully qualified name of the interface class that describes the desired service. Must not be null.
        filter - The filter criteria. May be null.
        Returns:
        Array of IRemoteServiceReferences matching given search criteria or null if no services are found that match the search.
        Throws:
        InvalidSyntaxException - If filter contains an invalid filter string that cannot be parsed.
        ContainerConnectException - if container cannot connect

      • asyncGetRemoteServiceReferences

        public org.eclipse.equinox.concurrent.future.IFuture asyncGetRemoteServiceReferences​(ID[] idFilter,
                                                                                     String clazz,
                                                                                     String filter)
        Description copied from interface: IRemoteServiceContainerAdapter
        Asynchronously returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class and match the specified idFilter, and filter criteria.

        Note this method assumes that the enclosing container has previously been connected, and uses the idFilter to filter among targets within the previously connected set of container IDs. To request connection as part of reference lookup, see IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID, String, String).

        The IFuture is returned immediately, and subsequent calls to IFuture.get() or IFuture.get(long) will return the actual results received. The type of the Object returned from IFuture.get() will be IRemoteServiceReference [].

        The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.

        idFilter is used to select a registered services that were registered by a given set of containers with id in idFilter. Only services exposed by a container with id in idFilter will be returned.

        If idFilter is null, all containers are considered to match the filter.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax.

        Specified by:
        asyncGetRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        asyncGetRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        idFilter - an array of ID instances that will restrict the search for matching container ids If null, all remote containers will be considered in search for matching IRemoteServiceReference instances. May be null.
        clazz - the fully qualified name of the interface class that describes the desired service. Must not be null.
        filter - The filter criteria. May be null.
        Returns:
        IFuture that through subsequent calls to IFuture#get() will return IRemoteServiceReference [] with IRemoteServiceReferences matching given search criteria. Will not return null.

      • asyncGetRemoteServiceReferences

        public org.eclipse.equinox.concurrent.future.IFuture asyncGetRemoteServiceReferences​(ID target,
                                                                                     String clazz,
                                                                                     String filter)
        Description copied from interface: IRemoteServiceContainerAdapter
        Asynchronously returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class and match the specified idFilter, and filter criteria.

        The IFuture is returned immediately, and subsequent calls to IFuture.get() or IFuture.get(long) will return the actual results received. The type of the Object returned from IFuture.get() will be IRemoteServiceReference [].

        The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.

        idFilter is used to select a registered services that were registered by a given set of containers with id in idFilter. Only services exposed by a container with id in idFilter will be returned.

        target is a remote container to connect to.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax.

        Specified by:
        asyncGetRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        asyncGetRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        target - an target to connect to if enclosing container is not already connected. May be null.
        clazz - the fully qualified name of the interface class that describes the desired service. Must not be null.
        filter - The filter criteria. May be null.
        Returns:
        IFuture that through subsequent calls to IFuture#get() will return IRemoteServiceReference [] with IRemoteServiceReferences matching given search criteria. Will not return null.

      • getAllRemoteServiceReferences

        public IRemoteServiceReference[] getAllRemoteServiceReferences​(String clazz,
                                                               String filter)
                                                        throws InvalidSyntaxException
        Description copied from interface: IRemoteServiceContainerAdapter

        Returns an array of IRemoteServiceReference objects. The returned array of IRemoteServiceReference objects contains services that were registered under the specified class, or if the clazz parameter is null all services registered.

        The list is valid at the time of the call to this method, however since the remote service container is a very dynamic environment, services can be modified or unregistered at anytime.

        filter is used to select the registered service whose properties objects contain keys and values which satisfy the filter. See Filter for a description of the filter string syntax.

        If filter is null, all registered services are considered to match the filter. If filter cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

        Specified by:
        getAllRemoteServiceReferences in interface IRemoteServiceConsumer
        Specified by:
        getAllRemoteServiceReferences in interface IRemoteServiceContainerAdapter
        Parameters:
        clazz - the fully qualified name of the interface class that describes the desired service. May be null.
        filter - The filter criteria. May be null.
        Returns:
        Array of IRemoteServiceReferences matching given search criteria or null if no services are found that match the search.
        Throws:
        InvalidSyntaxException - If filter contains an invalid filter string that cannot be parsed.

      • getRemoteServiceID

        public IRemoteServiceID getRemoteServiceID​(ID containerID,
                                           long containerRelativeID)
        Description copied from interface: IRemoteServiceContainerAdapter
        Get a remote service ID from a containerID and a containerRelative long value. Will return a non-null value if the IRemoteServiceRegistration/Reference is currently 'known' to this container adapter. null if not.
        Specified by:
        getRemoteServiceID in interface IRemoteServiceConsumer
        Specified by:
        getRemoteServiceID in interface IRemoteServiceContainerAdapter
        Specified by:
        getRemoteServiceID in interface IRemoteServiceHost
        Parameters:
        containerID - the containerID that is the server/host for the remote service. Must not be null. This must be the containerID for the server/host of the remote service.
        containerRelativeID - the long value identifying the remote service relative to the container ID.
        Returns:
        IRemoteServiceID instance if the associated IRemoteServiceRegistration/Reference is known to this container adapter, null if it is not.

      • setExecutor

        protected void setExecutor​(org.eclipse.equinox.concurrent.future.IExecutor executor)

      • getExecutor

        protected org.eclipse.equinox.concurrent.future.IExecutor getExecutor()

      • getContainer

        protected IContainer getContainer()

      • getLocalContainerID

        protected ID getLocalContainerID()

      • fireRemoteServiceListeners

        protected void fireRemoteServiceListeners​(IRemoteServiceEvent event)

      • checkServiceClass

        protected static String checkServiceClass​(String[] clazzes,
                                          Object serviceObject)