Package org.eclipse.ecf.remoteservice

Class RemoteServiceContainerAdapterImpl

java.lang.Object
org.eclipse.ecf.remoteservice.RemoteServiceContainerAdapterImpl
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, IRemoteServiceConsumer, IRemoteServiceContainerAdapter, IRemoteServiceHost
Direct Known Subclasses:
RSARemoteServiceContainerAdapter
public class RemoteServiceContainerAdapterImpl extends Object implements IRemoteServiceContainerAdapter
Since:
8.3

  • Field Details

  • Constructor Details

    • RemoteServiceContainerAdapterImpl

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

    • RemoteServiceContainerAdapterImpl

      public RemoteServiceContainerAdapterImpl(IContainer container)

  • Method Details

    • dispose

      public void dispose()

    • addRemoteServiceListener

      public void addRemoteServiceListener(IRemoteServiceListener listener)
      Description copied from interface: IRemoteServiceContainerAdapter
      Add listener for remote service registration/unregistration for this container
      Specified by:
      addRemoteServiceListener in interface IRemoteServiceConsumer
      Specified by:
      addRemoteServiceListener in interface IRemoteServiceContainerAdapter
      Specified by:
      addRemoteServiceListener in interface IRemoteServiceHost
      Parameters:
      listener - notified of service registration/unregistration events. Must not be null .

    • removeRemoteServiceListener

      public void removeRemoteServiceListener(IRemoteServiceListener listener)
      Description copied from interface: IRemoteServiceContainerAdapter
      Remove remote service registration/unregistration listener for this container.
      Specified by:
      removeRemoteServiceListener in interface IRemoteServiceConsumer
      Specified by:
      removeRemoteServiceListener in interface IRemoteServiceContainerAdapter
      Specified by:
      removeRemoteServiceListener in interface IRemoteServiceHost
      Parameters:
      listener - to remove. Must not be null .

    • setConnectContextForAuthentication

      public void setConnectContextForAuthentication(IConnectContext connectContext)
      Description copied from interface: IRemoteServiceContainerAdapter
      Set connect context for authentication upon subsequent calls to IRemoteServiceContainerAdapter.getRemoteServiceReferences(ID[], String, String) or IRemoteServiceContainerAdapter.asyncGetRemoteServiceReferences(ID[], String, String). This method should be called with a non-null connectContext in order to allow authentication to occur during.
      Specified by:
      setConnectContextForAuthentication in interface IRemoteServiceConsumer
      Specified by:
      setConnectContextForAuthentication in interface IRemoteServiceContainerAdapter
      Parameters:
      connectContext - the connect context to use for authenticating. If null, then no authentication will be attempted.

    • 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.

    • getRemoteServiceNamespace

      public Namespace getRemoteServiceNamespace()
      Description copied from interface: IRemoteServiceContainerAdapter
      Get namespace to use for this remote service provider.
      Specified by:
      getRemoteServiceNamespace in interface IRemoteServiceConsumer
      Specified by:
      getRemoteServiceNamespace in interface IRemoteServiceContainerAdapter
      Specified by:
      getRemoteServiceNamespace in interface IRemoteServiceHost
      Returns:
      Namespace to use for creating IRemoteServiceID for this remote service provider. Will not return null.

    • 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.

    • getRemoteServiceReference

      public IRemoteServiceReference getRemoteServiceReference(IRemoteServiceID serviceID)
      Description copied from interface: IRemoteServiceContainerAdapter
      Get the remote service reference known to this container for the given IRemoteServiceID. Note that this method must be guaranteed not to block by the provider implementation.
      Specified by:
      getRemoteServiceReference in interface IRemoteServiceConsumer
      Specified by:
      getRemoteServiceReference in interface IRemoteServiceContainerAdapter
      Parameters:
      serviceID - the serviceID to retrieve the IRemoteServiceReference for.
      Returns:
      IRemoteServiceReference the remote service reference associated with the given serviceID. Will return null if no IRemoteServiceReference found for the given serviceID.

    • getRemoteService

      public IRemoteService getRemoteService(IRemoteServiceReference reference)
      Description copied from interface: IRemoteServiceContainerAdapter
      Get remote service for given IRemoteServiceReference. Note that clients that call this method successfully should later call IRemoteServiceContainerAdapter.ungetRemoteService(IRemoteServiceReference) when the IRemoteService will no longer be used.
      Specified by:
      getRemoteService in interface IRemoteServiceConsumer
      Specified by:
      getRemoteService in interface IRemoteServiceContainerAdapter
      Parameters:
      reference - the IRemoteServiceReference for the desired service. Must not be null .
      Returns:
      IRemoteService representing the remote service. If remote service no longer exists for reference, then null is returned.
      See Also:

    • ungetRemoteService

      public boolean ungetRemoteService(IRemoteServiceReference ref)
      Description copied from interface: IRemoteServiceContainerAdapter
      Unget IRemoteServiceReference. Release all resources associated with the given IRemoteServiceReference. This method should be called by users of the IRemoteServiceReference that have previously called IRemoteServiceContainerAdapter.getRemoteService(IRemoteServiceReference). If this method returns true, then the previously used IRemoteService will no longer be usable.
      Specified by:
      ungetRemoteService in interface IRemoteServiceConsumer
      Specified by:
      ungetRemoteService in interface IRemoteServiceContainerAdapter
      Parameters:
      ref - the IRemoteServiceReference to unget
      Returns:
      true if unget successful, false if not. If this method returns true, then the IRemoteService instance previously retrieved via the given IRemoteServiceReference instance provided will no longer be usable.
      See Also:

    • createRemoteFilter

      public IRemoteFilter createRemoteFilter(String filter) throws InvalidSyntaxException
      Description copied from interface: IRemoteServiceContainerAdapter
      Creates a IRemoteFilter object. This IRemoteFilter object may be used to match a IRemoteServiceReference object or a Dictionary object.

      If the filter cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

      Specified by:
      createRemoteFilter in interface IRemoteServiceConsumer
      Specified by:
      createRemoteFilter in interface IRemoteServiceContainerAdapter
      Parameters:
      filter - The filter string.
      Returns:
      A IRemoteFilter object encapsulating the filter string.
      Throws:
      InvalidSyntaxException - If filter contains an invalid filter string that cannot be parsed.
      See Also:

    • getRemoteServiceCallPolicy

      protected IRemoteServiceCallPolicy getRemoteServiceCallPolicy()

    • getConnectContext

      protected IConnectContext getConnectContext()

    • 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()

    • getRegistry

      protected RemoteServiceRegistryImpl getRegistry()

    • setRegistry

      protected void setRegistry(RemoteServiceRegistryImpl registry)

    • createRemoteService

      protected AbstractRemoteService createRemoteService(RemoteServiceRegistrationImpl registration)

    • createRegisteredEvent

      protected IRemoteServiceRegisteredEvent createRegisteredEvent(RemoteServiceRegistrationImpl registration)

    • fireRemoteServiceListeners

      protected void fireRemoteServiceListeners(IRemoteServiceEvent event)

    • createRegistration

      protected RemoteServiceRegistrationImpl createRegistration()

    • createUnregisteredEvent

      protected IRemoteServiceUnregisteredEvent createUnregisteredEvent(RemoteServiceRegistrationImpl registration)

    • handleServiceUnregister

      protected void handleServiceUnregister(RemoteServiceRegistrationImpl registration)

    • getRemoteServiceRegistrationImpl

      protected RemoteServiceRegistrationImpl getRemoteServiceRegistrationImpl(IRemoteServiceReference reference)

    • connectToRemoteServiceTarget

      protected void connectToRemoteServiceTarget(ID target) throws ContainerConnectException
      Parameters:
      target - the ID target
      Throws:
      ContainerConnectException - container connect exception if cannot connect

    • checkServiceClass

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