jadex.bridge.service

Class BasicService

java.lang.Object

jadex.bridge.nonfunctional.NFPropertyProvider

jadex.bridge.nonfunctional.NFMethodPropertyProvider

jadex.bridge.service.BasicService

All Implemented Interfaces:

INFMethodPropertyProvider, INFMixedPropertyProvider, INFPropertyProvider, IInternalService, IService

Direct Known Subclasses:

BDIAgentFactory, BDIAgentFactory, BpmnFactory, MicroAgentFactory

public class BasicService
extends NFMethodPropertyProvider
implements IInternalService

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

Field Summary

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addNFProperties(NFProperties nfprops, Map<String,INFProperty<?,?>> nfps, IService ser, MethodInfo mi) Add nf properties from a type.
static IServiceIdentifier	createServiceIdentifier(IComponentIdentifier providerid, String servicename, Class<?> servicetype, Class<?> serviceimpl, IResourceIdentifier rid, String scope) Create a new service identifier.
void	createServiceIdentifier(String name, Class<?> implclazz, IResourceIdentifier rid, Class<?> type, String scope) Set the service identifier.
boolean	equals(Object obj) Check if the service is equal.
static String	generateServiceName(Class<?> service) Generate a unique name.
IInternalAccess	getInternalAccess() Get the internal access.
static long	getLocalDefaultTimeout() Get the local default timeout.
Map<String,Object>	getPropertyMap() Get a service property.
IComponentIdentifier	getProviderId() Get the providerid.
static long	getRemoteDefaultTimeout() Get the remote default timeout.
static long	getScaledLocalDefaultTimeout(double scale) Get the scaled local default timeout.
static long	getScaledRemoteDefaultTimeout(double scale) Get the scaled remote default timeout.
IServiceIdentifier	getServiceIdentifier() Get the service id.
int	hashCode() Get the hashcode.
void	initNFProperties()
IFuture<Boolean>	isValid() Test if the service is valid.
IFuture<Void>	setComponentAccess(IInternalAccess access) Sets the access for the component.
static void	setLocalDefaultTimeout(long timeout) Set the local default timeout.
void	setPropertyMap(Map<String,Object> properties) Set the properties.
static void	setRemoteDefaultTimeout(long timeout) Set the remote default timeout.
IFuture<Void>	shutdownService() Shutdown the service.
IFuture<Void>	startService() Start the service.
String	toString() Get a string representation.

Methods inherited from class jadex.bridge.nonfunctional.NFMethodPropertyProvider

addMethodNFProperty, getMethodNFAllPropertyNames, getMethodNFPropertyMetaInfo, getMethodNFPropertyMetaInfos, getMethodNFPropertyMetaInfos, getMethodNFPropertyNames, getMethodNFPropertyValue, getMethodNFPropertyValue, removeMethodNFProperty, shutdownNFPropertyProvider

Methods inherited from class jadex.bridge.nonfunctional.NFPropertyProvider

addNFProperty, getNFAllPropertyNames, getNFPropertyMetaInfo, getNFPropertyMetaInfos, getNFPropertyNames, getNFPropertyValue, getNFPropertyValue, getParent, removeNFProperty, setParent

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.bridge.nonfunctional.INFPropertyProvider

addNFProperty, getNFAllPropertyNames, getNFPropertyMetaInfo, getNFPropertyMetaInfos, getNFPropertyNames, getNFPropertyValue, getNFPropertyValue, removeNFProperty, shutdownNFPropertyProvider

Methods inherited from interface jadex.bridge.nonfunctional.INFMethodPropertyProvider

addMethodNFProperty, getMethodNFAllPropertyNames, getMethodNFPropertyMetaInfo, getMethodNFPropertyMetaInfos, getMethodNFPropertyMetaInfos, getMethodNFPropertyNames, getMethodNFPropertyValue, getMethodNFPropertyValue, removeMethodNFProperty, shutdownNFPropertyProvider

Constructor Detail

BasicService

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

Create a new service.

BasicService

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

Create a new service.

Method Detail

getRemoteDefaultTimeout

public static long getRemoteDefaultTimeout()

Get the remote default timeout.

getScaledRemoteDefaultTimeout

public static long getScaledRemoteDefaultTimeout(double scale)

Get the scaled remote default timeout.

getLocalDefaultTimeout

public static long getLocalDefaultTimeout()

Get the local default timeout.

getScaledLocalDefaultTimeout

public static long getScaledLocalDefaultTimeout(double scale)

Get the scaled local default timeout.

setRemoteDefaultTimeout

public static void setRemoteDefaultTimeout(long timeout)

Set the remote default timeout.

setLocalDefaultTimeout

public static void setLocalDefaultTimeout(long timeout)

Set the local default timeout.

initNFProperties

public void initNFProperties()

addNFProperties

public void addNFProperties(NFProperties nfprops,
                            Map<String,INFProperty<?,?>> nfps,
                            IService ser,
                            MethodInfo mi)

Add nf properties from a type.

isValid

public IFuture<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(String name,
                                    Class<?> implclazz,
                                    IResourceIdentifier rid,
                                    Class<?> type,
                                    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<Void> setComponentAccess(IInternalAccess access)

Sets the access for the component.

Specified by:

setComponentAccess in interface IInternalService

Parameters:

access - Component access.

getPropertyMap

public Map<String,Object> getPropertyMap()

Get a service property.

Specified by:

getPropertyMap in interface IService

Returns:

The service property (if any).

setPropertyMap

public void setPropertyMap(Map<String,Object> properties)

Set the properties.

Parameters:

properties - The properties to set.

startService

public IFuture<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<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 String generateServiceName(Class<?> service)

Generate a unique name.

Parameters:

The - calling service class.

createServiceIdentifier

public static IServiceIdentifier createServiceIdentifier(IComponentIdentifier providerid,
                                                         String servicename,
                                                         Class<?> servicetype,
                                                         Class<?> serviceimpl,
                                                         IResourceIdentifier rid,
                                                         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.

Specified by:

getInternalAccess in class NFPropertyProvider

equals

public boolean equals(Object obj)

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

Overrides:

equals in class 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 Object

toString

public String toString()

Get a string representation.

Overrides:

toString in class Object