jadex.bridge.service

Class BasicServiceContainer

java.lang.Object

jadex.bridge.service.BasicServiceContainer

All Implemented Interfaces:

IServiceContainer, IServiceProvider, IRemotable

Direct Known Subclasses:

ComponentServiceContainer

public abstract class BasicServiceContainer
extends Object
implements IServiceContainer

A service container is a simple infrastructure for a collection of services. It allows for starting/shutdowning the container and fetching service by their type/name.

Constructor Summary

Constructors

Constructor and Description
BasicServiceContainer(IComponentIdentifier id) Create a new service container.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterceptor(IServiceInvocationInterceptor interceptor, Object service, int pos) Add a service interceptor.
void	addRequiredServiceInfos(RequiredServiceInfo[] requiredservices) Add required services for a given prefix.
IFuture<Void>	addService(IInternalService service, ProvidedServiceInfo info) Add a service to the container.
abstract IRequiredServiceFetcher	createServiceFetcher(String name) Create a service fetcher.
boolean	equals(Object obj) Test if the object eqquals another one.
abstract IFuture<Collection<IServiceProvider>>	getChildren() Get the children container.
IComponentIdentifier	getId() Get the globally unique id of the provider.
IServiceInvocationInterceptor[]	getInterceptors(Object service) Get the interceptors of a service.
static long	getMethodTimeout(Class<?>[] interfaces, Method method, boolean remote) Get the default timeout for a method.
abstract IFuture<IServiceProvider>	getParent() Get the parent service container.
IService	getProvidedService(String name) Get provided (declared) service.
IService[]	getProvidedServices(Class<?> clazz) Get provided (declared) service.
IFuture<IService>	getRequiredService(RequiredServiceInfo info, RequiredServiceBinding binding) Get a required service.
<T> IFuture<T>	getRequiredService(RequiredServiceInfo info, RequiredServiceBinding binding, boolean rebind) Get a required service.
<T> IFuture<T>	getRequiredService(String name) Get a required service of a given name.
<T> IFuture<T>	getRequiredService(String name, boolean rebind) Get a required service.
RequiredServiceInfo	getRequiredServiceInfo(String name) Get a required service info.
RequiredServiceInfo[]	getRequiredServiceInfos() Get the required services.
IIntermediateFuture<IService>	getRequiredServices(RequiredServiceInfo info, RequiredServiceBinding binding) Get required services.
<T> IIntermediateFuture<T>	getRequiredServices(RequiredServiceInfo info, RequiredServiceBinding binding, boolean rebind) Get required services.
<T> IIntermediateFuture<T>	getRequiredServices(String name) Get a required services of a given name.
<T> IIntermediateFuture<T>	getRequiredServices(String name, boolean rebind) Get a required services.
<T> IFuture<T>	getService(Class<T> type, IComponentIdentifier cid) Get one service of a type from a specific component.
IIntermediateFuture<IService>	getServices(ISearchManager manager, IVisitDecider decider, IResultSelector selector) Get all services of a type.
abstract IFuture<Class<?>>	getServiceType(IServiceIdentifier sid)
String	getType() Get the type of the service provider (e.g. enclosing component type).
int	hashCode() Get the hashcode.
void	removeInterceptor(IServiceInvocationInterceptor interceptor, Object service) Remove a service interceptor.
IFuture<Void>	removeService(IServiceIdentifier sid) Removes a service from the platform (shutdowns also the service).
IFuture<Void>	serviceShutdowned(IInternalService service) Called after a service has been shutdowned.
IFuture<Void>	serviceStarted(IInternalService service) Called after a service has been started.
void	setRequiredServiceInfos(RequiredServiceInfo[] requiredservices) Set the required services.
IFuture<Void>	shutdown() Shutdown the service.
IFuture<Void>	start() Start the service.
String	toString() Get the string representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.bridge.service.IServiceContainer

searchService, searchService, searchServices, searchServices, searchServiceUpwards

Constructor Detail

BasicServiceContainer

public BasicServiceContainer(IComponentIdentifier id)

Create a new service container.

Method Detail

getServices

public IIntermediateFuture<IService> getServices(ISearchManager manager,
                                        IVisitDecider decider,
                                        IResultSelector selector)

Get all services of a type.

Specified by:

getServices in interface IServiceProvider

Parameters:

clazz - The class.

Returns:

The corresponding services.

getParent

public abstract IFuture<IServiceProvider> getParent()

Get the parent service container.

Specified by:

getParent in interface IServiceProvider

Returns:

The parent container.

getChildren

public abstract IFuture<Collection<IServiceProvider>> getChildren()

Get the children container.

Specified by:

getChildren in interface IServiceProvider

Returns:

The children container.

getId

public IComponentIdentifier getId()

Get the globally unique id of the provider.

Specified by:

getId in interface IServiceProvider

Returns:

The id of this provider.

getType

public String getType()

Get the type of the service provider (e.g. enclosing component type).

Specified by:

getType in interface IServiceProvider

Returns:

The type of this provider.

addService

public IFuture<Void> addService(IInternalService service,
                       ProvidedServiceInfo info)

Add a service to the container.

Specified by:

addService in interface IServiceContainer

Parameters:

id - The name.

service - The service.

Returns:

A future that is done when the service has completed starting.

removeService

public IFuture<Void> removeService(IServiceIdentifier sid)

Removes a service from the platform (shutdowns also the service).

Specified by:

removeService in interface IServiceContainer

Parameters:

id - The name.

service - The service.

Returns:

A future that is done when the service has completed its shutdown.

start

public IFuture<Void> start()

Start the service.

Specified by:

start in interface IServiceContainer

Returns:

A future that is done when the service has completed starting.

shutdown

public IFuture<Void> shutdown()

Shutdown the service.

Specified by:

shutdown in interface IServiceContainer

Returns:

A future that is done when the service has completed its shutdown.

serviceStarted

public IFuture<Void> serviceStarted(IInternalService service)

Called after a service has been started.

serviceShutdowned

public IFuture<Void> serviceShutdowned(IInternalService service)

Called after a service has been shutdowned.

getService

public <T> IFuture<T> getService(Class<T> type,
                        IComponentIdentifier cid)

Get one service of a type from a specific component.

Specified by:

getService in interface IServiceContainer

Parameters:

type - The class.

cid - The component identifier of the target component.

Returns:

The corresponding service.

getProvidedService

public IService getProvidedService(String name)

Get provided (declared) service.

Specified by:

getProvidedService in interface IServiceContainer

Parameters:

name - The service name.

Returns:

The service.

getProvidedServices

public IService[] getProvidedServices(Class<?> clazz)

Get provided (declared) service.

Specified by:

getProvidedServices in interface IServiceContainer

Parameters:

clazz - The interface.

Returns:

The service.

getRequiredServiceInfos

public RequiredServiceInfo[] getRequiredServiceInfos()

Get the required services.

Specified by:

getRequiredServiceInfos in interface IServiceContainer

Returns:

The required services.

setRequiredServiceInfos

public void setRequiredServiceInfos(RequiredServiceInfo[] requiredservices)

Set the required services.

Specified by:

setRequiredServiceInfos in interface IServiceContainer

Parameters:

required - services The required services to set.

addRequiredServiceInfos

public void addRequiredServiceInfos(RequiredServiceInfo[] requiredservices)

Add required services for a given prefix.

Specified by:

addRequiredServiceInfos in interface IServiceContainer

Parameters:

prefix - The name prefix to use.

required - services The required services to set.

getRequiredServiceInfo

public RequiredServiceInfo getRequiredServiceInfo(String name)

Get a required service info.

Specified by:

getRequiredServiceInfo in interface IServiceContainer

Parameters:

name - The name.

Returns:

The required service info.

getRequiredService

public IFuture<IService> getRequiredService(RequiredServiceInfo info,
                                   RequiredServiceBinding binding)

Get a required service.

Returns:

The service.

getRequiredServices

public IIntermediateFuture<IService> getRequiredServices(RequiredServiceInfo info,
                                                RequiredServiceBinding binding)

Get required services.

Returns:

The services.

getRequiredService

public <T> IFuture<T> getRequiredService(String name)

Get a required service of a given name.

Specified by:

getRequiredService in interface IServiceContainer

Parameters:

name - The service name.

Returns:

The service.

getRequiredServices

public <T> IIntermediateFuture<T> getRequiredServices(String name)

Get a required services of a given name.

Specified by:

getRequiredServices in interface IServiceContainer

Parameters:

name - The services name.

Returns:

The service.

getRequiredService

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

Get a required service.

Specified by:

getRequiredService in interface IServiceContainer

Returns:

The service.

getRequiredServices

public <T> IIntermediateFuture<T> getRequiredServices(String name,
                                             boolean rebind)

Get a required services.

Specified by:

getRequiredServices in interface IServiceContainer

Returns:

The services.

getRequiredService

public <T> IFuture<T> getRequiredService(RequiredServiceInfo info,
                                RequiredServiceBinding binding,
                                boolean rebind)

Get a required service.

Returns:

The service.

getRequiredServices

public <T> IIntermediateFuture<T> getRequiredServices(RequiredServiceInfo info,
                                             RequiredServiceBinding binding,
                                             boolean rebind)

Get required services.

Returns:

The services.

createServiceFetcher

public abstract IRequiredServiceFetcher createServiceFetcher(String name)

Create a service fetcher.

addInterceptor

public void addInterceptor(IServiceInvocationInterceptor interceptor,
                  Object service,
                  int pos)

Add a service interceptor.

Specified by:

addInterceptor in interface IServiceContainer

Parameters:

interceptor - The interceptor.

service - The service.

pos - The position (0=first, -1=last-1, i.e. one before method invocation).

removeInterceptor

public void removeInterceptor(IServiceInvocationInterceptor interceptor,
                     Object service)

Remove a service interceptor.

Specified by:

removeInterceptor in interface IServiceContainer

Parameters:

interceptor - The interceptor.

service - The service.

getInterceptors

public IServiceInvocationInterceptor[] getInterceptors(Object service)

Get the interceptors of a service.

Specified by:

getInterceptors in interface IServiceContainer

Parameters:

service - The service.

Returns:

The interceptors.

getServiceType

public abstract IFuture<Class<?>> getServiceType(IServiceIdentifier sid)

toString

public String toString()

Get the string representation.

Overrides:

toString in class Object

Returns:

The string representation.

hashCode

public int hashCode()

Get the hashcode.

Overrides:

hashCode in class Object

Returns:

The hashcode.

equals

public boolean equals(Object obj)

Test if the object eqquals another one.

Overrides:

equals in class Object

Parameters:

obj - The object.

Returns:

true, if both are equal.

getMethodTimeout

public static long getMethodTimeout(Class<?>[] interfaces,
                    Method method,
                    boolean remote)

Get the default timeout for a method.