jadex.bdi

Class BDIAgentFactory

java.lang.Object

jadex.bridge.nonfunctional.NFPropertyProvider

jadex.bridge.nonfunctional.NFMethodPropertyProvider

jadex.bridge.service.BasicService

jadex.bdi.BDIAgentFactory

All Implemented Interfaces:

IDynamicBDIFactory, INFMethodPropertyProvider, INFMixedPropertyProvider, INFPropertyProvider, IInternalService, IService, IComponentFactory, jadex.kernelbase.IBootstrapFactory

public class BDIAgentFactory
extends BasicService
implements IDynamicBDIFactory, IComponentFactory, jadex.kernelbase.IBootstrapFactory

Factory for creating Jadex V2 BDI agents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILETYPE_BDIAGENT The BDI agent file type.
static String	FILETYPE_BDICAPABILITY The BDI capability file type.
static String[]	FILETYPES The supported component types (file extensions).

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

Constructor and Description
BDIAgentFactory(Map<String,Object> props, IInternalAccess component) Create a new agent factory.
BDIAgentFactory(String dummy) Create a new agent factory.

Method Summary

Modifier and Type	Method and Description
IFuture<IMECapability>	createAgentModel(String name, String pkg, String[] imports, IResourceIdentifier rid) Create a new agent model, which can be manually edited before starting.
IFuture<Tuple2<IComponentInstance,IComponentAdapter>>	createComponentInstance(IComponentDescription desc, IComponentAdapterFactory factory, IModelInfo modelinfo, String config, Map<String,Object> arguments, IExternalAccess parent, RequiredServiceBinding[] bindings, ProvidedServiceInfo[] pinfos, boolean copy, boolean realtime, boolean persist, IPersistInfo persistinfo, IIntermediateResultListener<Tuple2<String,Object>> resultlistener, Future<Void> init, LocalServiceRegistry registry) Create a component instance.
Tuple2<IComponentInstance,IComponentAdapter>	createComponentInstance(IComponentDescription desc, IComponentAdapterFactory factory, OAVAgentModel amodel, String config, Map<String,Object> arguments, IExternalAccess parent, RequiredServiceBinding[] bindings, ProvidedServiceInfo[] pinfos, boolean copy, boolean realtime, IIntermediateResultListener<Tuple2<String,Object>> resultlistener, Future<Void> ret, LocalServiceRegistry registry) Create a component instance.
IFuture<String>	getComponentType(String model, String[] imports, IResourceIdentifier rid) Get the component type of a model.
IFuture<byte[]>	getComponentTypeIcon(String type) Get a default icon for a file type.
String[]	getComponentTypes() Get the names of ADF file types supported by this factory.
Map	getProperties(String type) Get the properties.
IFuture<Boolean>	isLoadable(String model, String[] imports, IResourceIdentifier rid) Test if a model can be loaded by the factory.
IFuture<Boolean>	isStartable(String model, String[] imports, IResourceIdentifier rid) Test if a model is startable (e.g.
IFuture<IModelInfo>	loadAgentModel(String name, InputStream input, String filename, IResourceIdentifier rid) Load a model from an input stream.
IFuture<IModelInfo>	loadModel(String filename, String[] imports, IResourceIdentifier rid) Load a model.
IFuture<IModelInfo>	registerAgentModel(IMECapability model, String filename) Register a manually edited agent model in the factory.
IFuture<Void>	shutdownService() Shutdown the service.
IFuture<Void>	startService() Start the service.
IFuture<Void>	startService(IInternalAccess component, IResourceIdentifier rid) Start the service.

Methods inherited from class jadex.bridge.service.BasicService

addNFProperties, createServiceIdentifier, createServiceIdentifier, equals, generateServiceName, getInternalAccess, getLocalDefaultTimeout, getPropertyMap, getProviderId, getRemoteDefaultTimeout, getScaledLocalDefaultTimeout, getScaledRemoteDefaultTimeout, getServiceIdentifier, hashCode, initNFProperties, isValid, setComponentAccess, setLocalDefaultTimeout, setPropertyMap, setRemoteDefaultTimeout, toString

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

Field Detail

FILETYPES

public static final String[] FILETYPES

The supported component types (file extensions). Convention used by platform config panel.

FILETYPE_BDIAGENT

public static final String FILETYPE_BDIAGENT

The BDI agent file type.

See Also:

Constant Field Values

FILETYPE_BDICAPABILITY

public static final String FILETYPE_BDICAPABILITY

The BDI capability file type.

See Also:

Constant Field Values

Constructor Detail

BDIAgentFactory

public BDIAgentFactory(String dummy)

Create a new agent factory.

BDIAgentFactory

public BDIAgentFactory(Map<String,Object> props,
                       IInternalAccess component)

Create a new agent factory.

Method Detail

startService

public IFuture<Void> startService(IInternalAccess component,
                                  IResourceIdentifier rid)

Start the service.

Specified by:

startService in interface jadex.kernelbase.IBootstrapFactory

startService

public IFuture<Void> startService()

Start the service.

Specified by:

startService in interface IInternalService

Overrides:

startService in class BasicService

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

Overrides:

shutdownService in class BasicService

Parameters:

listener - The listener.

Returns:

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

createComponentInstance

public IFuture<Tuple2<IComponentInstance,IComponentAdapter>> createComponentInstance(IComponentDescription desc,
                                                                                     IComponentAdapterFactory factory,
                                                                                     IModelInfo modelinfo,
                                                                                     String config,
                                                                                     Map<String,Object> arguments,
                                                                                     IExternalAccess parent,
                                                                                     RequiredServiceBinding[] bindings,
                                                                                     ProvidedServiceInfo[] pinfos,
                                                                                     boolean copy,
                                                                                     boolean realtime,
                                                                                     boolean persist,
                                                                                     IPersistInfo persistinfo,
                                                                                     IIntermediateResultListener<Tuple2<String,Object>> resultlistener,
                                                                                     Future<Void> init,
                                                                                     LocalServiceRegistry registry)

Create a component instance.

Specified by:

createComponentInstance in interface IComponentFactory

Parameters:

desc - The component description.

factory - The component adapter factory.

modelinfo - The component model.

config - The name of the configuration (or null for default configuration)

arguments - The arguments for the component as name/value pairs.

parent - The parent component (if any).

bindings - Optional bindings to override bindings from model.

pinfos - Optional provided service infos to override settings from model.

copy - Global flag for parameter copying.

realtime - Global flag for real time timeouts.

persist - Global flag for persistence support.

resultlistener - Optional listener to be notified when the component finishes.

init - Future to be notified when init of the component is completed.

Returns:

An instance of a component and the corresponding adapter.

createComponentInstance

public Tuple2<IComponentInstance,IComponentAdapter> createComponentInstance(IComponentDescription desc,
                                                                            IComponentAdapterFactory factory,
                                                                            OAVAgentModel amodel,
                                                                            String config,
                                                                            Map<String,Object> arguments,
                                                                            IExternalAccess parent,
                                                                            RequiredServiceBinding[] bindings,
                                                                            ProvidedServiceInfo[] pinfos,
                                                                            boolean copy,
                                                                            boolean realtime,
                                                                            IIntermediateResultListener<Tuple2<String,Object>> resultlistener,
                                                                            Future<Void> ret,
                                                                            LocalServiceRegistry registry)

Create a component instance.

Parameters:

adapter - The component adapter.

model - The component model.

config - The name of the configuration (or null for default configuration)

arguments - The arguments for the agent as name/value pairs.

parent - The parent component (if any).

Returns:

An instance of a component.

loadModel

public IFuture<IModelInfo> loadModel(String filename,
                                     String[] imports,
                                     IResourceIdentifier rid)

Load a model.

Specified by:

loadModel in interface IComponentFactory

Parameters:

filename - The model (e.g. file name).

The - imports (if any).

Returns:

The loaded model.

isLoadable

public IFuture<Boolean> isLoadable(String model,
                                   String[] imports,
                                   IResourceIdentifier rid)

Test if a model can be loaded by the factory.

Specified by:

isLoadable in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

Returns:

True, if model can be loaded.

isStartable

public IFuture<Boolean> isStartable(String model,
                                    String[] imports,
                                    IResourceIdentifier rid)

Test if a model is startable (e.g. an component).

Specified by:

isStartable in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

Returns:

True, if startable (and loadable).

getComponentTypes

public String[] getComponentTypes()

Get the names of ADF file types supported by this factory.

Specified by:

getComponentTypes in interface IComponentFactory

getComponentTypeIcon

public IFuture<byte[]> getComponentTypeIcon(String type)

Get a default icon for a file type.

Specified by:

getComponentTypeIcon in interface IComponentFactory

getComponentType

public IFuture<String> getComponentType(String model,
                                        String[] imports,
                                        IResourceIdentifier rid)

Get the component type of a model.

Specified by:

getComponentType in interface IComponentFactory

Parameters:

model - The model (e.g. file name).

The - imports (if any).

getProperties

public Map getProperties(String type)

Get the properties. Arbitrary properties that can e.g. be used to define kernel-specific settings to configure tools.

Specified by:

getProperties in interface IComponentFactory

Parameters:

type - The component type.

Returns:

The properties or null, if the component type is not supported by this factory.

createAgentModel

public IFuture<IMECapability> createAgentModel(String name,
                                               String pkg,
                                               String[] imports,
                                               IResourceIdentifier rid)

Create a new agent model, which can be manually edited before starting.

Specified by:

createAgentModel in interface IDynamicBDIFactory

Parameters:

name - A type name for the agent model.

pkg - Optional package for the model.

imports - Optional imports for the model.

registerAgentModel

public IFuture<IModelInfo> registerAgentModel(IMECapability model,
                                              String filename)

Register a manually edited agent model in the factory.

Specified by:

registerAgentModel in interface IDynamicBDIFactory

Parameters:

model - The edited agent model.

filename - The filename for accessing the model.

Returns:

The startable agent model.

loadAgentModel

public IFuture<IModelInfo> loadAgentModel(String name,
                                          InputStream input,
                                          String filename,
                                          IResourceIdentifier rid)

Load a model from an input stream.

Specified by:

loadAgentModel in interface IDynamicBDIFactory

Parameters:

name - The simple model name.

input - The stream with the agent xml.

filename - The full name for accessing the model after loading.

rid - The resource identifier for loading referenced classes etc.

Returns:

The startable agent model.