jadex.bridge.service.search

Class SynchronizedServiceRegistry

java.lang.Object

jadex.bridge.service.search.SynchronizedServiceRegistry

All Implemented Interfaces:

IServiceRegistry

public class SynchronizedServiceRegistry
extends java.lang.Object
implements IServiceRegistry

Synchronization for service registries. The syncglobal allows allows to state whether calls to the global search methods should hold the read lock or not. In case of the old search based registry this is not allowed because the registry them might block writes changes up to the deftimeout of the platform. In case of the new synchronization based registry the lock should be held. Note: Readers will NOT be tracked asynchronously, i.e. the readercnt variable is made +1 at start of method and -1 at the end of the method. Thus, all async code must operate on safe copy state. (Holding the readercnt in async code leads to log running readers. These methods will hinder the writer to update the registry - can only update when the last reader has left).

Field Summary

Fields

Modifier and Type	Field and Description
protected IServiceRegistry	delegate The service registry calls are delegated to.
protected java.util.concurrent.locks.ReentrantLock	lock Flag that a writer is performing updates.
protected int	readercnt The reader count.
protected boolean	syncglobal Flag if global searches should be synchronized.
protected java.util.List<Tuple2<IResultCommand<IFuture<java.lang.Void>,java.lang.Void>,Future<java.lang.Void>>>	writeactions The scheduled write actions (deferred when readers are currrently reading).

Constructor Summary

Constructors

Constructor and Description
SynchronizedServiceRegistry(boolean syncglobal, IServiceRegistry delegate) Create a new SynchronizedMultiServiceRegistry.

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 SynchronizedServiceRegistry	getRegistry(IComponentIdentifier platform) Get the registry from a component.
static SynchronizedServiceRegistry	getRegistry(IInternalAccess ia) Get the registry from a component.
java.util.Map<ClassInfo,java.util.Set<IService>>	getServiceMap() todo: WARNING: dangerous method that exposes the internal data structure Get the service map.
java.util.Iterator<IService>	getServices(ClassInfo type) Get the services per type.
IServiceRegistry	getSubregistry(IComponentIdentifier cid) Get a subregistry.
boolean	isIncluded(IComponentIdentifier cid, IService ser) Test if a service is included.
protected void	lock() Method that tries to get the lock and blocks otherwise (will terminate blocking after 3 seconds forcefully).
protected void	performWrites() Perform the scheduled write actions.
protected java.lang.Object	readActionSync(IResultCommand<java.lang.Object,java.lang.Void> command, java.lang.String op)
protected void	readerDec() Get the lock and decrement the readers variable.
protected void	readerInc(java.lang.String op) Get the lock and increment the readers variable.
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 an existing registry.
<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.
<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.
protected void	unlock() Method that unlocks the lock.
protected IFuture<java.lang.Void>	writeAction(IResultCommand<IFuture<java.lang.Void>,java.lang.Void> command)

Methods inherited from class java.lang.Object

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

Field Detail

readercnt

protected int readercnt

The reader count.

lock

protected java.util.concurrent.locks.ReentrantLock lock

Flag that a writer is performing updates.

writeactions

protected java.util.List<Tuple2<IResultCommand<IFuture<java.lang.Void>,java.lang.Void>,Future<java.lang.Void>>> writeactions

The scheduled write actions (deferred when readers are currrently reading).

delegate

protected IServiceRegistry delegate

The service registry calls are delegated to.

syncglobal

protected boolean syncglobal

Flag if global searches should be synchronized.

Constructor Detail

SynchronizedServiceRegistry

public SynchronizedServiceRegistry(boolean syncglobal,
                                   IServiceRegistry delegate)

Create a new SynchronizedMultiServiceRegistry.

Method Detail

lock

protected void lock()

Method that tries to get the lock and blocks otherwise (will terminate blocking after 3 seconds forcefully).

unlock

protected void unlock()

Method that unlocks the lock.

writeAction

protected IFuture<java.lang.Void> writeAction(IResultCommand<IFuture<java.lang.Void>,java.lang.Void> command)

Parameters:

command -

Returns:

readActionSync

protected java.lang.Object readActionSync(IResultCommand<java.lang.Object,java.lang.Void> command,
                                          java.lang.String op)

Parameters:

command -

Returns:

addService

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

Add a service to the registry.

Specified by:

addService in interface IServiceRegistry

Parameters:

sid - The service id.

removeService

public void removeService(ClassInfo key,
                          IService service)

Remove a service from the registry.

Specified by:

removeService in interface IServiceRegistry

Parameters:

sid - The service id.

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.

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

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

getRegistry

public static SynchronizedServiceRegistry getRegistry(IComponentIdentifier platform)

Get the registry from a component.

getRegistry

public static SynchronizedServiceRegistry getRegistry(IInternalAccess ia)

Get the registry from a component.

readerInc

protected void readerInc(java.lang.String op)

Get the lock and increment the readers variable.

readerDec

protected void readerDec()

Get the lock and decrement the readers variable.

performWrites

protected void performWrites()

Perform the scheduled write actions.

getServices

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

Get the services per type. Internally used -> always safe

Specified by:

getServices in interface IServiceRegistry

Parameters:

type - The type.

Returns:

Iterator with services.

addExcludedComponent

public void addExcludedComponent(IComponentIdentifier cid)

Add an excluded component.

Specified by:

addExcludedComponent in interface IServiceRegistry

Parameters:

The - component identifier.

removeExcludedComponent

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

Remove an excluded component.

Specified by:

removeExcludedComponent in interface IServiceRegistry

Parameters:

The - component identifier.

isIncluded

public boolean isIncluded(IComponentIdentifier cid,
                          IService ser)

Test if a service is included.

Specified by:

isIncluded in interface IServiceRegistry

Parameters:

ser - The service.

Returns:

True if is included.

getServiceMap

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

todo: WARNING: dangerous method that exposes the internal data structure Get the service map.

Specified by:

getServiceMap in interface IServiceRegistry

Returns:

The full service map.

getQueries

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

Get queries per type.

Specified by:

getQueries in interface IServiceRegistry

Parameters:

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

Returns:

The queries.

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.

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 an existing registry.

Specified by:

removeSubregistry in interface IServiceRegistry

Parameters:

cid - The component id to remove.