jadex.bridge.service.search

Class ServiceRegistry

java.lang.Object

jadex.bridge.service.search.ServiceRegistry

All Implemented Interfaces:

IRegistryDataProvider, IServiceRegistry

Direct Known Subclasses:

GlobalQueryServiceRegistry

public class ServiceRegistry
extends java.lang.Object
implements IServiceRegistry, IRegistryDataProvider

Local service registry. - Search fetches services by types and excludes some according to the scope. - Allows for adding persistent queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceRegistry.UnlimitedIntermediateDelegationResultListener<E> Listener that forwards only results and ignores finished / exception.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<IComponentIdentifier>	excluded The excluded components.
protected java.util.Map<IComponentIdentifier,java.util.Set<IService>>	excludedservices The excluded services cache.
protected java.util.List<IRegistryListener>	listeners The registry listeners.
protected java.util.Map<ClassInfo,java.util.Set<ServiceQueryInfo<?>>>	queries The persistent service queries.
protected RegistrySearchFunctionality	searchfunc The search functionality.
protected java.util.Map<ClassInfo,java.util.Set<IService>>	services The map of published services sorted by type.

Constructor Summary

Constructors

Constructor and Description
ServiceRegistry() Create a new registry.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(IRegistryListener listener) Add an event listener.
void	addExcludedComponent(IComponentIdentifier cid) Add an excluded component.
<T> ISubscriptionIntermediateFuture<T>	addQuery(ServiceQuery<T> query) Add a service query to the registry.
IFuture<java.lang.Void>	addService(ClassInfo key, IService service) Add a service to the registry.
<T> java.util.Set<ServiceQueryInfo<T>>	getQueries(ClassInfo type) Get queries per type.
static IServiceRegistry	getRegistry(IComponentIdentifier platform) Get the registry from a component.
static IServiceRegistry	getRegistry(IInternalAccess ia) Get the registry from a component.
protected <T> T	getService(java.lang.Class<T> type) Get a service per type.
java.util.Map<ClassInfo,java.util.Set<IService>>	getServiceMap() Get the service map.
java.util.Iterator<IService>	getServices(ClassInfo type) Get services per type.
IServiceRegistry	getSubregistry(IComponentIdentifier cid) Get a subregistry.
boolean	isIncluded(IComponentIdentifier cid, IService ser) Test if a service is included.
protected void	notifyListeners(RegistryListenerEvent event) Notify the event listeners (if any).
void	removeEventListener(IRegistryListener listener) Remove an event listener.
IFuture<java.lang.Void>	removeExcludedComponent(IComponentIdentifier cid) Remove an excluded component.
void	removeQueries(IComponentIdentifier owner) Remove all service queries of a specific component from the registry.
<T> void	removeQuery(ServiceQuery<T> query) Remove a service query from the registry.
void	removeService(ClassInfo key, IService service) Remove a service from the registry.
void	removeSubregistry(IComponentIdentifier cid) Remove a subregistry.
<T> IFuture<T>	searchGlobalService(ClassInfo type, IComponentIdentifier cid, IAsyncFilter<T> filter) Search for services.
<T> ISubscriptionIntermediateFuture<T>	searchGlobalServices(ClassInfo type, IComponentIdentifier cid, IAsyncFilter<T> filter) Search for services.
protected <T> IFuture<T>	searchRemoteService(IComponentIdentifier caller, ClassInfo type, IAsyncFilter<T> filter) Search for services on remote platforms.
protected <T> ITerminableIntermediateFuture<T>	searchRemoteServices(IComponentIdentifier caller, ClassInfo type, IAsyncFilter<T> filter) Search for services on remote platforms.
<T> T	searchService(ClassInfo type, IComponentIdentifier cid, java.lang.String scope) Search for services.
<T> T	searchService(ClassInfo type, IComponentIdentifier cid, java.lang.String scope, boolean excluded) Search for services.
<T> IFuture<T>	searchService(ClassInfo type, IComponentIdentifier cid, java.lang.String scope, IAsyncFilter<T> filter) Search for service.
<T> T	searchService(ClassInfo type, IComponentIdentifier cid, java.lang.String scope, IFilter<T> filter) Search for service.
<T> java.util.Collection<T>	searchServices(ClassInfo type, IComponentIdentifier cid, java.lang.String scope) Search for services.
<T> ISubscriptionIntermediateFuture<T>	searchServices(ClassInfo type, IComponentIdentifier cid, java.lang.String scope, IAsyncFilter<T> filter) Search for services.
<T> java.util.Collection<T>	searchServices(ClassInfo type, IComponentIdentifier cid, java.lang.String scope, IFilter<T> filter) Search for service.

Methods inherited from class java.lang.Object

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

Field Detail

services

protected java.util.Map<ClassInfo,java.util.Set<IService>> services

The map of published services sorted by type.

excluded

protected java.util.Set<IComponentIdentifier> excluded

The excluded components.

queries

protected java.util.Map<ClassInfo,java.util.Set<ServiceQueryInfo<?>>> queries

The persistent service queries.

excludedservices

protected java.util.Map<IComponentIdentifier,java.util.Set<IService>> excludedservices

The excluded services cache.

listeners

protected java.util.List<IRegistryListener> listeners

The registry listeners.

searchfunc

protected RegistrySearchFunctionality searchfunc

The search functionality.

Constructor Detail

ServiceRegistry

public ServiceRegistry()

Create a new registry.

Method Detail

getService

protected <T> T getService(java.lang.Class<T> type)

Get a service per type.

Parameters:

type - The interface type.

Returns:

First matching service or null.

getServices

public java.util.Iterator<IService> getServices(ClassInfo type)

Get services per type.

Specified by:

getServices in interface IRegistryDataProvider

Specified by:

getServices in interface IServiceRegistry

Parameters:

type - The interface type. If type is null all services are returned.

Returns:

First matching service or null.

isIncluded

public boolean isIncluded(IComponentIdentifier cid,
                          IService ser)

Test if a service is included.

Specified by:

isIncluded in interface IRegistryDataProvider

Specified by:

isIncluded in interface IServiceRegistry

Parameters:

ser - The service.

Returns:

True if is included.

addExcludedComponent

public void addExcludedComponent(IComponentIdentifier cid)

Add an excluded component.

Specified by:

addExcludedComponent in interface IServiceRegistry

Parameters:

cid - component identifier.

removeExcludedComponent

public IFuture<java.lang.Void> removeExcludedComponent(IComponentIdentifier cid)

Remove an excluded component.

Specified by:

removeExcludedComponent in interface IServiceRegistry

Parameters:

cid - component identifier.

addService

public IFuture<java.lang.Void> addService(ClassInfo key,
                                          IService service)

Add a service to the registry.

Specified by:

addService in interface IServiceRegistry

Parameters:

service - The service.

removeService

public void removeService(ClassInfo key,
                          IService service)

Remove a service from the registry.

Specified by:

removeService in interface IServiceRegistry

Parameters:

service - The service.

searchService

public <T> T searchService(ClassInfo type,
                           IComponentIdentifier cid,
                           java.lang.String scope)

Search for services.

Specified by:

searchService in interface IServiceRegistry

searchService

public <T> T searchService(ClassInfo type,
                           IComponentIdentifier cid,
                           java.lang.String scope,
                           boolean excluded)

Search for services.

Specified by:

searchService in interface IServiceRegistry

searchServices

public <T> java.util.Collection<T> searchServices(ClassInfo type,
                                                  IComponentIdentifier cid,
                                                  java.lang.String scope)

Search for services.

Specified by:

searchServices in interface IServiceRegistry

searchService

public <T> T searchService(ClassInfo type,
                           IComponentIdentifier cid,
                           java.lang.String scope,
                           IFilter<T> filter)

Search for service.

Specified by:

searchService in interface IServiceRegistry

searchServices

public <T> java.util.Collection<T> searchServices(ClassInfo type,
                                                  IComponentIdentifier cid,
                                                  java.lang.String scope,
                                                  IFilter<T> filter)

Search for service.

Specified by:

searchServices in interface IServiceRegistry

searchService

public <T> IFuture<T> searchService(ClassInfo type,
                                    IComponentIdentifier cid,
                                    java.lang.String scope,
                                    IAsyncFilter<T> filter)

Search for service.

Specified by:

searchService in interface IServiceRegistry

searchServices

public <T> ISubscriptionIntermediateFuture<T> searchServices(ClassInfo type,
                                                             IComponentIdentifier cid,
                                                             java.lang.String scope,
                                                             IAsyncFilter<T> filter)

Search for services.

Specified by:

searchServices in interface IServiceRegistry

addQuery

public <T> ISubscriptionIntermediateFuture<T> addQuery(ServiceQuery<T> query)

Add a service query to the registry.

Specified by:

addQuery in interface IServiceRegistry

Parameters:

query - ServiceQuery.

removeQuery

public <T> void removeQuery(ServiceQuery<T> query)

Remove a service query from the registry.

Specified by:

removeQuery in interface IServiceRegistry

Parameters:

query - ServiceQuery.

removeQueries

public void removeQueries(IComponentIdentifier owner)

Remove all service queries of a specific component from the registry.

Specified by:

removeQueries in interface IServiceRegistry

Parameters:

owner - The query owner.

getQueries

public <T> java.util.Set<ServiceQueryInfo<T>> getQueries(ClassInfo type)

Get queries per type.

Specified by:

getQueries in interface IRegistryDataProvider

Specified by:

getQueries in interface IServiceRegistry

Parameters:

type - The interface type. If type is null all services are returned.

Returns:

The queries.

searchGlobalService

public <T> IFuture<T> searchGlobalService(ClassInfo type,
                                          IComponentIdentifier cid,
                                          IAsyncFilter<T> filter)

Search for services.

Specified by:

searchGlobalService in interface IServiceRegistry

searchGlobalServices

public <T> ISubscriptionIntermediateFuture<T> searchGlobalServices(ClassInfo type,
                                                                   IComponentIdentifier cid,
                                                                   IAsyncFilter<T> filter)

Search for services.

Specified by:

searchGlobalServices in interface IServiceRegistry

searchRemoteServices

protected <T> ITerminableIntermediateFuture<T> searchRemoteServices(IComponentIdentifier caller,
                                                                    ClassInfo type,
                                                                    IAsyncFilter<T> filter)

Search for services on remote platforms.

Parameters:

caller - The component that started the search.

type - The type.

filter - The filter.

searchRemoteService

protected <T> IFuture<T> searchRemoteService(IComponentIdentifier caller,
                                             ClassInfo type,
                                             IAsyncFilter<T> filter)

Search for services on remote platforms.

Parameters:

type - The type.

filter - The filter.

getSubregistry

public IServiceRegistry getSubregistry(IComponentIdentifier cid)

Get a subregistry.

Specified by:

getSubregistry in interface IServiceRegistry

Parameters:

cid - The platform id.

Returns:

The registry.

removeSubregistry

public void removeSubregistry(IComponentIdentifier cid)

Remove a subregistry.

Specified by:

removeSubregistry in interface IServiceRegistry

Parameters:

cid - The platform id.

getServiceMap

public java.util.Map<ClassInfo,java.util.Set<IService>> getServiceMap()

Get the service map. (The original map cannot be used because registry is accessed concurrently and other threads could change the map even in between of onging operations such as serialization)

Specified by:

getServiceMap in interface IServiceRegistry

Returns:

A clone of the service map.

notifyListeners

protected void notifyListeners(RegistryListenerEvent event)

Notify the event listeners (if any).

Parameters:

event - The event.

addEventListener

public void addEventListener(IRegistryListener listener)

Add an event listener.

Specified by:

addEventListener in interface IServiceRegistry

Parameters:

listener - The listener.

removeEventListener

public void removeEventListener(IRegistryListener listener)

Remove an event listener.

Specified by:

removeEventListener in interface IServiceRegistry

Parameters:

listener - The listener.

getRegistry

public static IServiceRegistry getRegistry(IComponentIdentifier platform)

Get the registry from a component.

getRegistry

public static IServiceRegistry getRegistry(IInternalAccess ia)

Get the registry from a component.