jadex.bridge.service.component

Class RequiredServicesComponentFeature

java.lang.Object

AbstractComponentFeature

jadex.bridge.service.component.RequiredServicesComponentFeature

All Implemented Interfaces:

IRequiredServicesFeature

public class RequiredServicesComponentFeature
extends AbstractComponentFeature
implements IRequiredServicesFeature

Feature for provided services.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,IRequiredServiceFetcher>	reqservicefetchers The service fetch method table (name -> fetcher).
protected java.util.Map<java.lang.String,RequiredServiceInfo>	requiredserviceinfos The required service infos.

Constructor Summary

Constructors

Constructor and Description
RequiredServicesComponentFeature(IInternalAccess component, ComponentCreationInfo cinfo) Factory method constructor for instance level.

Method Summary

Modifier and Type	Method and Description
<T> ISubscriptionIntermediateFuture<T>	addQuery(java.lang.Class<T> type, java.lang.String scope, IAsyncFilter<T> filter) Add a service query to the registry.
protected void	addRequiredServiceInfos(RequiredServiceInfo[] requiredservices) Add required services for a given prefix.
IRequiredServiceFetcher	createServiceFetcher(java.lang.String name) Create a service fetcher.
IComponentIdentifier	getId() Get the globally unique id of the provider.
<T> T	getLastRequiredService(java.lang.String name) Get the result of the last search.
<T> java.util.Collection<T>	getLastRequiredServices(java.lang.String name) Get the result of the last search.
<T> T	getMultiService(java.lang.String reqname, java.lang.Class<T> multitype) Get a multi service.
protected <T> IFuture<T>	getRequiredService(RequiredServiceInfo info, RequiredServiceBinding binding, boolean rebind, IAsyncFilter<T> filter) Get a required service.
<T> IFuture<T>	getRequiredService(java.lang.String name) Get a required service of a given name.
<T> IFuture<T>	getRequiredService(java.lang.String name, boolean rebind) Get a required service.
<T> IFuture<T>	getRequiredService(java.lang.String name, boolean rebind, IAsyncFilter<T> filter) Get a required service.
<T> IFuture<T>	getRequiredService(java.lang.String name, boolean rebind, java.lang.String... tags) Get a required service using tags.
protected IRequiredServiceFetcher	getRequiredServiceFetcher(java.lang.String name) Get a required service fetcher.
RequiredServiceInfo	getRequiredServiceInfo(java.lang.String name) Get a required service info.
RequiredServiceInfo[]	getRequiredServiceInfos() Get the required services.
protected <T> ITerminableIntermediateFuture<T>	getRequiredServices(RequiredServiceInfo info, RequiredServiceBinding binding, boolean rebind, IAsyncFilter<T> filter) Get required services.
<T> ITerminableIntermediateFuture<T>	getRequiredServices(java.lang.String name) Get a required services of a given name.
<T> ITerminableIntermediateFuture<T>	getRequiredServices(java.lang.String name, boolean rebind) Get a required services.
<T> ITerminableIntermediateFuture<T>	getRequiredServices(java.lang.String name, boolean rebind, IAsyncFilter<T> filter) Get a required services.
<T> ITerminableIntermediateFuture<T>	getRequiredServices(java.lang.String name, boolean rebind, java.lang.String... tags) Get a required services using tags.
boolean	hasUserBody() Check if the feature potentially executed user code in body.
IFuture<java.lang.Void>	init() Init the required services
<T> IFuture<T>	searchService(java.lang.Class<T> type) Get one service of a type.
<T> IFuture<T>	searchService(java.lang.Class<T> type, IComponentIdentifier cid) Get one service of a type from a specific component.
<T> IFuture<T>	searchService(java.lang.Class<T> type, java.lang.String scope) Get one service of a type.
<T> ITerminableIntermediateFuture<T>	searchServices(java.lang.Class<T> type) Get all services of a type.
<T> ITerminableIntermediateFuture<T>	searchServices(java.lang.Class<T> type, java.lang.String scope) Get all services of a type.
void	setRequiredServiceInfos(RequiredServiceInfo[] requiredservices) Set the required services.
IFuture<java.lang.Void>	shutdown() Called when the feature is shutdowned.

Methods inherited from class java.lang.Object

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

Field Detail

reqservicefetchers

protected java.util.Map<java.lang.String,IRequiredServiceFetcher> reqservicefetchers

The service fetch method table (name -> fetcher).

requiredserviceinfos

protected java.util.Map<java.lang.String,RequiredServiceInfo> requiredserviceinfos

The required service infos.

Constructor Detail

RequiredServicesComponentFeature

public RequiredServicesComponentFeature(IInternalAccess component,
                                        ComponentCreationInfo cinfo)

Factory method constructor for instance level.

Method Detail

init

public IFuture<java.lang.Void> init()

Init the required services

hasUserBody

public boolean hasUserBody()

Check if the feature potentially executed user code in body. Allows blocking operations in user bodies by using separate steps for each feature. Non-user-body-features are directly executed for speed. If unsure just return true. ;-)

shutdown

public IFuture<java.lang.Void> shutdown()

Called when the feature is shutdowned.

addRequiredServiceInfos

protected void addRequiredServiceInfos(RequiredServiceInfo[] requiredservices)

Add required services for a given prefix.

Parameters:

prefix - The name prefix to use.

required - services The required services to set.

getRequiredServiceInfo

public RequiredServiceInfo getRequiredServiceInfo(java.lang.String name)

Get a required service info.

Specified by:

getRequiredServiceInfo in interface IRequiredServicesFeature

Parameters:

name - The name.

Returns:

The required service info.

getRequiredServiceInfos

public RequiredServiceInfo[] getRequiredServiceInfos()

Get the required services.

Specified by:

getRequiredServiceInfos in interface IRequiredServicesFeature

Returns:

The required services.

setRequiredServiceInfos

public void setRequiredServiceInfos(RequiredServiceInfo[] requiredservices)

Set the required services.

Parameters:

required - services The required services to set.

getRequiredService

public <T> IFuture<T> getRequiredService(java.lang.String name)

Get a required service of a given name.

Specified by:

getRequiredService in interface IRequiredServicesFeature

Parameters:

name - The service name.

Returns:

The service.

getRequiredServices

public <T> ITerminableIntermediateFuture<T> getRequiredServices(java.lang.String name)

Get a required services of a given name.

Specified by:

getRequiredServices in interface IRequiredServicesFeature

Parameters:

name - The services name.

Returns:

The service.

getRequiredService

public <T> IFuture<T> getRequiredService(java.lang.String name,
                                         boolean rebind)

Get a required service.

Specified by:

getRequiredService in interface IRequiredServicesFeature

Parameters:

name - The required service name.

rebind - If false caches results.

Returns:

The service.

getRequiredServices

public <T> ITerminableIntermediateFuture<T> getRequiredServices(java.lang.String name,
                                                                boolean rebind)

Get a required services.

Specified by:

getRequiredServices in interface IRequiredServicesFeature

Parameters:

name - The required service name.

rebind - If false caches results.

Returns:

The services.

getRequiredServices

public <T> ITerminableIntermediateFuture<T> getRequiredServices(java.lang.String name,
                                                                boolean rebind,
                                                                IAsyncFilter<T> filter)

Get a required services.

Specified by:

getRequiredServices in interface IRequiredServicesFeature

Parameters:

name - The required service name.

rebind - If false caches results.

Returns:

The services.

getRequiredService

public <T> IFuture<T> getRequiredService(java.lang.String name,
                                         boolean rebind,
                                         java.lang.String... tags)

Get a required service using tags.

Specified by:

getRequiredService in interface IRequiredServicesFeature

Parameters:

name - The required service name.

rebind - If false caches results.

tags - The service tags.

Returns:

The service.

getRequiredServices

public <T> ITerminableIntermediateFuture<T> getRequiredServices(java.lang.String name,
                                                                boolean rebind,
                                                                java.lang.String... tags)

Get a required services using tags.

Specified by:

getRequiredServices in interface IRequiredServicesFeature

Parameters:

name - The required service name.

rebind - If false caches results.

tags - The service tags.

Returns:

Each service as an intermediate result and a collection of services as final result.

getMultiService

public <T> T getMultiService(java.lang.String reqname,
                             java.lang.Class<T> multitype)

Get a multi service.

Parameters:

reqname - The required service name.

multitype - The interface of the multi service.

getRequiredService

protected <T> IFuture<T> getRequiredService(RequiredServiceInfo info,
                                            RequiredServiceBinding binding,
                                            boolean rebind,
                                            IAsyncFilter<T> filter)

Get a required service.

Returns:

The service.

getRequiredServices

protected <T> ITerminableIntermediateFuture<T> getRequiredServices(RequiredServiceInfo info,
                                                                   RequiredServiceBinding binding,
                                                                   boolean rebind,
                                                                   IAsyncFilter<T> filter)

Get required services.

Returns:

The services.

getRequiredService

public <T> IFuture<T> getRequiredService(java.lang.String name,
                                         boolean rebind,
                                         IAsyncFilter<T> filter)

Get a required service.

Specified by:

getRequiredService in interface IRequiredServicesFeature

Parameters:

name - The required service name.

rebind - If false caches results.

Returns:

The service.

getLastRequiredService

public <T> T getLastRequiredService(java.lang.String name)

Get the result of the last search.

Specified by:

getLastRequiredService in interface IRequiredServicesFeature

Parameters:

name - The required service name.

Returns:

The last result.

getLastRequiredServices

public <T> java.util.Collection<T> getLastRequiredServices(java.lang.String name)

Get the result of the last search.

Specified by:

getLastRequiredServices in interface IRequiredServicesFeature

Parameters:

name - The required services name.

Returns:

The last result.

searchService

public <T> IFuture<T> searchService(java.lang.Class<T> type)

Get one service of a type.

Specified by:

searchService in interface IRequiredServicesFeature

Parameters:

type - The class.

Returns:

The corresponding service.

searchService

public <T> IFuture<T> searchService(java.lang.Class<T> type,
                                    java.lang.String scope)

Get one service of a type.

Specified by:

searchService in interface IRequiredServicesFeature

Parameters:

type - The class.

Returns:

The corresponding service.

searchServices

public <T> ITerminableIntermediateFuture<T> searchServices(java.lang.Class<T> type)

Get all services of a type.

Specified by:

searchServices in interface IRequiredServicesFeature

Parameters:

type - The class.

Returns:

Each service as an intermediate result and a collection of services as final result.

searchServices

public <T> ITerminableIntermediateFuture<T> searchServices(java.lang.Class<T> type,
                                                           java.lang.String scope)

Get all services of a type.

Specified by:

searchServices in interface IRequiredServicesFeature

Parameters:

type - The class.

Returns:

Each service as an intermediate result and a collection of services as final result.

searchService

public <T> IFuture<T> searchService(java.lang.Class<T> type,
                                    IComponentIdentifier cid)

Get one service of a type from a specific component.

Specified by:

searchService in interface IRequiredServicesFeature

Parameters:

type - The class.

cid - The component identifier of the target component.

Returns:

The corresponding service.

getRequiredServiceFetcher

protected IRequiredServiceFetcher getRequiredServiceFetcher(java.lang.String name)

Get a required service fetcher.

Parameters:

name - The required service name.

Returns:

The service fetcher.

createServiceFetcher

public IRequiredServiceFetcher createServiceFetcher(java.lang.String name)

Create a service fetcher.

getId

public IComponentIdentifier getId()

Get the globally unique id of the provider.

Returns:

The id of this provider.

addQuery

public <T> ISubscriptionIntermediateFuture<T> addQuery(java.lang.Class<T> type,
                                                       java.lang.String scope,
                                                       IAsyncFilter<T> filter)

Add a service query to the registry.

Specified by:

addQuery in interface IRequiredServicesFeature

Parameters:

type - The service type.

scope - The scope.

filter - The filter.