jadex.bridge.service

Class BasicService

java.lang.Object

jadex.bridge.service.BasicService

All Implemented Interfaces:

IInternalService, IService

Direct Known Subclasses:

BDIAgentFactory, BpmnFactory, MicroAgentFactory

public class BasicService
extends 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
static long	DEFAULT_LOCAL Constant for local default timeout.
static long	DEFAULT_REMOTE Constant for remote default timeout.

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static IServiceIdentifier	createServiceIdentifier(IComponentIdentifier providerid, String servicename, Class<?> servicetype, Class<?> serviceimpl, IResourceIdentifier rid) Create a new service identifier.
void	createServiceIdentifier(String name, Class<?> implclazz, IResourceIdentifier rid, Class<?> type) Set the service identifier.
boolean	equals(Object obj) Check if the service is equal.
static String	generateServiceName(Class<?> service) Generate a unique name.
Map<String,Object>	getPropertyMap() Get a service property.
IComponentIdentifier	getProviderId() Get the providerid.
IServiceIdentifier	getServiceIdentifier() Get the service id.
IFuture<Boolean>	isValid() Test if the service is valid.
void	setPropertyMap(Map<String,Object> properties) Set the properties.
IFuture<Void>	shutdownService() Shutdown the service.
IFuture<Void>	startService() Start the service.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REMOTE

public static long DEFAULT_REMOTE

Constant for remote default timeout.

DEFAULT_LOCAL

public static long DEFAULT_LOCAL

Constant for local default timeout.

Constructor Detail

BasicService

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

Create a new service.

Method Detail

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)

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.

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)

Create a new service identifier.

Parameters:

providerid - The provider id.

servicename - The service name.

Returns:

A service identifier.

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.