jadex.bridge.service

Class BasicService

java.lang.Object

jadex.bridge.service.BasicService

All Implemented Interfaces:

IInternalService, IService

Direct Known Subclasses:

BDIAgentFactory, BDIXComponentFactory, BpmnFactory, MicroAgentFactory

public class BasicService
extends java.lang.Object
implements IInternalService

Basic service provide a simple default isValid() implementation that returns true after start service and false afterwards.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	idcnt The id counter.
protected java.lang.Class<?>	impltype
protected IInternalAccess	internalaccess Internal access to its component.
protected IComponentIdentifier	providerid The provider id.
protected boolean	shutdowned The shutdowned state.
protected IServiceIdentifier	sid The service id.
protected boolean	started The started state.
protected java.lang.Class<?>	type

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

Constructor and Description
BasicService(IComponentIdentifier providerid, java.lang.Class<?> type, java.lang.Class<?> impltype, java.util.Map<java.lang.String,java.lang.Object> properties) Create a new service.
BasicService(IComponentIdentifier providerid, java.lang.Class<?> type, java.util.Map<java.lang.String,java.lang.Object> properties) Create a new service.

Method Summary

Modifier and Type	Method and Description
static IServiceIdentifier	createServiceIdentifier(IComponentIdentifier providerid, java.lang.String servicename, java.lang.Class<?> servicetype, java.lang.Class<?> serviceimpl, IResourceIdentifier rid, java.lang.String scope) Create a new service identifier.
void	createServiceIdentifier(java.lang.String name, java.lang.Class<?> implclazz, IResourceIdentifier rid, java.lang.Class<?> type, java.lang.String scope) Set the service identifier.
boolean	equals(java.lang.Object obj) Check if the service is equal.
static java.lang.String	generateServiceName(java.lang.Class<?> service) Generate a unique name.
java.lang.Class<?>	getInterfaceType() Get the interface type.
IInternalAccess	getInternalAccess() Get the internal access.
static long	getMethodTimeout(java.lang.Class<?>[] interfaces, java.lang.reflect.Method method, boolean remote) Get the default timeout for a method.
java.util.Map<java.lang.String,java.lang.Object>	getPropertyMap() Get a service property.
IComponentIdentifier	getProviderId() Get the providerid.
IServiceIdentifier	getServiceIdentifier() Get the service id.
int	hashCode() Get the hashcode.
protected IFuture<java.lang.Void>	initNFProperties() Init the non-functional properties (todo: move to other location?)
IFuture<java.lang.Boolean>	isValid() Test if the service is valid.
IFuture<java.lang.Void>	setComponentAccess(IInternalAccess access) Sets the access for the component.
void	setPropertyMap(java.util.Map<java.lang.String,java.lang.Object> properties) Set the properties.
IFuture<java.lang.Void>	shutdownService() Shutdown the service.
IFuture<java.lang.Void>	startService() Start the service.
java.lang.String	toString() Get a string representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

idcnt

protected static long idcnt

The id counter.

internalaccess

protected IInternalAccess internalaccess

Internal access to its component.

started

protected boolean started

The started state.

shutdowned

protected boolean shutdowned

The shutdowned state.

sid

protected IServiceIdentifier sid

The service id.

providerid

protected IComponentIdentifier providerid

The provider id.

type

protected java.lang.Class<?> type

impltype

protected java.lang.Class<?> impltype

Constructor Detail

BasicService

public BasicService(IComponentIdentifier providerid,
                    java.lang.Class<?> type,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

Create a new service.

BasicService

public BasicService(IComponentIdentifier providerid,
                    java.lang.Class<?> type,
                    java.lang.Class<?> impltype,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

Create a new service.

Method Detail

isValid

public IFuture<java.lang.Boolean> isValid()

Test if the service is valid.

Specified by:

isValid in interface IService

Returns:

True, if service can be used. todo: why is method synchronized?

createServiceIdentifier

public void createServiceIdentifier(java.lang.String name,
                                    java.lang.Class<?> implclazz,
                                    IResourceIdentifier rid,
                                    java.lang.Class<?> type,
                                    java.lang.String scope)

Set the service identifier.

Specified by:

createServiceIdentifier in interface IInternalService

getServiceIdentifier

public IServiceIdentifier getServiceIdentifier()

Get the service id.

Specified by:

getServiceIdentifier in interface IService

Returns:

The service id.

getProviderId

public IComponentIdentifier getProviderId()

Get the providerid.

Returns:

the providerid.

setComponentAccess

public IFuture<java.lang.Void> setComponentAccess(IInternalAccess access)

Sets the access for the component.

Specified by:

setComponentAccess in interface IInternalService

Parameters:

access - Component access.

initNFProperties

protected IFuture<java.lang.Void> initNFProperties()

Init the non-functional properties (todo: move to other location?)

getPropertyMap

public java.util.Map<java.lang.String,java.lang.Object> getPropertyMap()

Get a service property.

Specified by:

getPropertyMap in interface IService

Returns:

The service property (if any).

setPropertyMap

public void setPropertyMap(java.util.Map<java.lang.String,java.lang.Object> properties)

Set the properties.

Parameters:

properties - The properties to set.

startService

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

Start the service.

Specified by:

startService in interface IInternalService

Returns:

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

shutdownService

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

Shutdown the service.

Specified by:

shutdownService in interface IInternalService

Returns:

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

generateServiceName

public static java.lang.String generateServiceName(java.lang.Class<?> service)

Generate a unique name.

Parameters:

The - calling service class.

createServiceIdentifier

public static IServiceIdentifier createServiceIdentifier(IComponentIdentifier providerid,
                                                         java.lang.String servicename,
                                                         java.lang.Class<?> servicetype,
                                                         java.lang.Class<?> serviceimpl,
                                                         IResourceIdentifier rid,
                                                         java.lang.String scope)

Create a new service identifier.

Parameters:

providerid - The provider id.

servicename - The service name.

Returns:

A service identifier.

getInternalAccess

public IInternalAccess getInternalAccess()

Get the internal access.

equals

public boolean equals(java.lang.Object obj)

Check if the service is equal. The service is considered equal if the service identifiers match.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object of comparison.

Returns:

True, if the object is a service with a matching service identifier.

hashCode

public int hashCode()

Get the hashcode.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Get a string representation.

Overrides:

toString in class java.lang.Object

getMethodTimeout

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

Get the default timeout for a method.

getInterfaceType

public java.lang.Class<?> getInterfaceType()

Get the interface type.

Returns:

The interface type.