jadex.bridge.service

Interface IServiceContainer

All Superinterfaces:

IRemotable, IServiceProvider

All Known Implementing Classes:

BasicServiceContainer, CacheServiceContainer, ComponentServiceContainer

public interface IServiceContainer
extends IServiceProvider

Internal interface for a service container. Allows adding and removing services.

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.
IServiceInvocationInterceptor[]	getInterceptors(Object service) Get the interceptors of a service.
IService	getProvidedService(String name) Get provided (declared) service.
IService[]	getProvidedServices(Class<?> clazz) Get provided (declared) 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 the required service info.
RequiredServiceInfo[]	getRequiredServiceInfos() Get the required service infos.
<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.
void	removeInterceptor(IServiceInvocationInterceptor interceptor, Object service) Remove a service interceptor.
IFuture<Void>	removeService(IServiceIdentifier sid) Removes a service from the container (shutdowns also the service if the container is running).
<T> IFuture<T>	searchService(Class<T> type) Get one service of a type.
<T> IFuture<T>	searchService(Class<T> type, String scope) Get one service of a type.
<T> IIntermediateFuture<T>	searchServices(Class<T> type) Get all services of a type.
<T> IIntermediateFuture<T>	searchServices(Class<T> type, String scope) Get all services of a type.
<T> IFuture<T>	searchServiceUpwards(Class<T> type) Get one service of a type and only search upwards (parents).
void	setRequiredServiceInfos(RequiredServiceInfo[] requiredservices) Set the required services.
IFuture<Void>	shutdown() Shutdown the service.
IFuture<Void>	start() Start the service.

Methods inherited from interface jadex.bridge.service.IServiceProvider

getChildren, getId, getParent, getServices, getType

Method Detail

start

IFuture<Void> start()

Start the service.

Returns:

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

shutdown

IFuture<Void> shutdown()

Shutdown the service.

Returns:

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

addService

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

Add a service to the container. The service is started, if the container is already running.

Parameters:

service - The service.

info - The provided service info.

Returns:

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

removeService

IFuture<Void> removeService(IServiceIdentifier sid)

Removes a service from the container (shutdowns also the service if the container is running).

Parameters:

service - The service identifier.

Returns:

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

getProvidedService

IService getProvidedService(String name)

Get provided (declared) service.

Parameters:

name - The service name.

Returns:

The service.

getProvidedServices

IService[] getProvidedServices(Class<?> clazz)

Get provided (declared) service.

Parameters:

clazz - The interface.

Returns:

The service.

getRequiredServiceInfos

RequiredServiceInfo[] getRequiredServiceInfos()

Get the required service infos.

getRequiredServiceInfo

RequiredServiceInfo getRequiredServiceInfo(String name)

Get the required service info.

Parameters:

name - The name.

Returns:

The required service info.

setRequiredServiceInfos

void setRequiredServiceInfos(RequiredServiceInfo[] requiredservices)

Set the required services.

Parameters:

required - services The required services to set.

addRequiredServiceInfos

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.

getRequiredService

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

Get a required service of a given name.

Parameters:

name - The service name.

Returns:

The service.

getRequiredServices

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

Get a required services of a given name.

Parameters:

name - The services name.

Returns:

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

getRequiredService

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

Get a required service.

Returns:

The service.

getRequiredServices

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

Get a required services.

Returns:

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

addInterceptor

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

Add a service interceptor.

Parameters:

interceptor - The interceptor.

service - The service.

pos - The position (0=first).

removeInterceptor

void removeInterceptor(IServiceInvocationInterceptor interceptor,
                     Object service)

Remove a service interceptor.

Parameters:

interceptor - The interceptor.

service - The service.

getInterceptors

IServiceInvocationInterceptor[] getInterceptors(Object service)

Get the interceptors of a service.

Parameters:

service - The service.

Returns:

The interceptors.

getService

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

Get one service of a type from a specific component.

Parameters:

type - The class.

cid - The component identifier of the target component.

Returns:

The corresponding service.

searchService

<T> IFuture<T> searchService(Class<T> type)

Get one service of a type.

Parameters:

type - The class.

Returns:

The corresponding service.

searchService

<T> IFuture<T> searchService(Class<T> type,
                           String scope)

Get one service of a type.

Parameters:

type - The class.

Returns:

The corresponding service.

searchServiceUpwards

<T> IFuture<T> searchServiceUpwards(Class<T> type)

Get one service of a type and only search upwards (parents).

Parameters:

type - The class.

Returns:

The corresponding service.

searchServices

<T> IIntermediateFuture<T> searchServices(Class<T> type)

Get all services of a type.

Parameters:

type - The class.

Returns:

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

searchServices

<T> IIntermediateFuture<T> searchServices(Class<T> type,
                                        String scope)

Get all services of a type.

Parameters:

type - The class.

Returns:

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