Package jadex.micro

Class MicroAgentFactory

java.lang.Object

jadex.bridge.service.BasicService

jadex.micro.MicroAgentFactory

All Implemented Interfaces:

IInternalService, IService, IBootstrapFactory, IComponentFactory

public class MicroAgentFactory
extends BasicService
implements IComponentFactory, IBootstrapFactory

Factory for creating micro agents.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Collection<IComponentFeatureFactory>	features	The standard + micro component features.
static java.lang.String	FILETYPE_MICROAGENT	The micro agent file type.
static java.lang.String[]	FILETYPES	The supported component types (file extensions).
protected java.util.Map<java.lang.String,java.lang.Object>	fproperties	The properties.
protected static LazyResource	ICON	The image icon.
protected ILibraryServiceListener	libservicelistener	The library service listener
protected MicroModelLoader	loader	The application model loader.
static java.util.Collection<IComponentFeatureFactory>	MICRO_FEATURES	The specific component features for micro agents.
static java.util.Collection<IComponentFeatureFactory>	NOPLATFORM_DEFAULT_FEATURES	The default component features.
protected IInternalAccess	provider	The platform.
static java.lang.String	TYPE	The annotation typename used in @Agent.

Fields inherited from class jadex.bridge.service.BasicService

DEFAULT_SYSTEM_SECURITY, idcnt, impltype, internalaccess, providerid, shutdowned, sid, started, type

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

Constructor	Description
MicroAgentFactory(IInternalAccess provider, java.util.Map<java.lang.String,java.lang.Object> properties)	Create a new agent factory.
MicroAgentFactory(java.lang.String providerid)	Create a new agent factory for startup.

Method Summary

Modifier and Type	Method	Description
static IFuture<IExternalAccess>	createAgent(java.lang.String filename, IExecutionService es, IClockService cs)	Create a micro agent using services.
java.lang.String[]	getComponentAnnotationTypes()
IFuture<java.util.Collection<IComponentFeatureFactory>>	getComponentFeatures(IModelInfo model, java.lang.Object pojo)	Get the component features for a model.
IFuture<java.lang.String>	getComponentType(java.lang.String model, java.lang.String[] imports, IResourceIdentifier rid)	Get the component type of a model.
IFuture<byte[]>	getComponentTypeIcon(java.lang.String type)	Get a default icon for a file type.
java.lang.String[]	getComponentTypes()	Get the names of ADF file types supported by this factory.
protected ILibraryService	getLibraryService()	Get the library service
java.util.Map<java.lang.String,java.lang.Object>	getProperties(java.lang.String type)	Get the properties.
protected java.util.Collection<IComponentFeatureFactory>	getStandardFeatures()	Get the standard micro features.
java.lang.String	getTypeName()	Get the agent type name.
IFuture<java.lang.Boolean>	isLoadable(java.lang.String model, java.lang.Object pojo, java.lang.String[] imports, IResourceIdentifier rid)	Test if a model can be loaded by the factory.
IFuture<java.lang.Boolean>	isStartable(java.lang.String model, java.lang.Object pojo, java.lang.String[] imports, IResourceIdentifier rid)	Test if a model is startable (e.g.
IFuture<IModelInfo>	loadModel(java.lang.String model, java.lang.Object pojo, java.lang.String[] imports, IResourceIdentifier rid)	Load a model.
void	setFeatures(java.util.Collection<IComponentFeatureFactory> features)	Set the features.
IFuture<java.lang.Void>	shutdownService()	Shutdown the service.
IFuture<java.lang.Void>	startService(IInternalAccess component, IResourceIdentifier rid)	Start the service.

Methods inherited from class jadex.bridge.service.BasicService

createServiceIdentifier, createServiceIdentifier, equals, generateServiceName, getInterfaceType, getInternalAccess, getInvokeMethod, getMethodInfos, getMethodTimeout, getPropertyMap, getProviderId, getSecurityLevel, getServiceId, hashCode, initNFProperties, invokeMethod, isUnrestricted, isValid, setComponentAccess, setPropertyMap, setServiceIdentifier, startService, toString

Methods inherited from class java.lang.Object

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

Field Detail

NOPLATFORM_DEFAULT_FEATURES

public static final java.util.Collection<IComponentFeatureFactory> NOPLATFORM_DEFAULT_FEATURES

The default component features.

FILETYPES

public static final java.lang.String[] FILETYPES

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

FILETYPE_MICROAGENT

public static final java.lang.String FILETYPE_MICROAGENT

The micro agent file type.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

The annotation typename used in @Agent.

See Also:

Constant Field Values

ICON

protected static final LazyResource ICON

The image icon.

MICRO_FEATURES

public static final java.util.Collection<IComponentFeatureFactory> MICRO_FEATURES

The specific component features for micro agents.

loader

protected MicroModelLoader loader

The application model loader.

provider

protected IInternalAccess provider

The platform.

fproperties

protected java.util.Map<java.lang.String,java.lang.Object> fproperties

The properties.

libservicelistener

protected ILibraryServiceListener libservicelistener

The library service listener

features

protected java.util.Collection<IComponentFeatureFactory> features

The standard + micro component features.

Constructor Detail

MicroAgentFactory

public MicroAgentFactory(IInternalAccess provider,
                         java.util.Map<java.lang.String,java.lang.Object> properties)

Create a new agent factory.

MicroAgentFactory

public MicroAgentFactory(java.lang.String providerid)

Create a new agent factory for startup.

Parameters:

platform - The platform.

Method Detail

createAgent

public static IFuture<IExternalAccess> createAgent(java.lang.String filename,
                                                   IExecutionService es,
                                                   IClockService cs)

Create a micro agent using services.

Parameters:

filename - The agent filename.

es - The execution service.

cs - The clock service.

Returns:

The external access of the agent.

getStandardFeatures

protected java.util.Collection<IComponentFeatureFactory> getStandardFeatures()

Get the standard micro features. NOTE: This is used to give the reader the standard features. It needs them when a user defines @Features and only wants to add some new.

Returns:

The standard features for a micro component.

setFeatures

public void setFeatures(java.util.Collection<IComponentFeatureFactory> features)

Set the features.

Parameters:

features - The features to set.

startService

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

Start the service.

Specified by:

startService in interface IBootstrapFactory

Parameters:

component - The component.

rid - The resource identifier.

shutdownService

public IFuture<java.lang.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.

loadModel

public IFuture<IModelInfo> loadModel(java.lang.String model,
                                     java.lang.Object pojo,
                                     java.lang.String[] imports,
                                     IResourceIdentifier rid)

Load a model.

Specified by:

loadModel in interface IComponentFactory

Parameters:

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

The - imports (if any).

Returns:

The loaded model.

isLoadable

public IFuture<java.lang.Boolean> isLoadable(java.lang.String model,
                                             java.lang.Object pojo,
                                             java.lang.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<java.lang.Boolean> isStartable(java.lang.String model,
                                              java.lang.Object pojo,
                                              java.lang.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 java.lang.String[] getComponentTypes()

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

Specified by:

getComponentTypes in interface IComponentFactory

getComponentAnnotationTypes

public java.lang.String[] getComponentAnnotationTypes()

Specified by:

getComponentAnnotationTypes in interface IComponentFactory

getComponentTypeIcon

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

Get a default icon for a file type.

Specified by:

getComponentTypeIcon in interface IComponentFactory

getComponentType

public IFuture<java.lang.String> getComponentType(java.lang.String model,
                                                  java.lang.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).

getComponentFeatures

public IFuture<java.util.Collection<IComponentFeatureFactory>> getComponentFeatures(IModelInfo model,
                                                                                    java.lang.Object pojo)

Get the component features for a model.

Specified by:

getComponentFeatures in interface IComponentFactory

Parameters:

model - The component model.

Returns:

The component features.

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties(java.lang.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.

getLibraryService

protected ILibraryService getLibraryService()

Get the library service

getTypeName

public java.lang.String getTypeName()

Get the agent type name.

Returns:

The type name.