jadex.base

Class StarterConfiguration

java.lang.Object

jadex.base.StarterConfiguration

All Implemented Interfaces:

IStarterConfiguration

public class StarterConfiguration
extends java.lang.Object
implements IStarterConfiguration

Configuration of the platform setup.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	cmdargs Command line arguments.
protected java.util.List<java.lang.String>	components Components to start.
protected ConfigurationInfo	configurationInfo Name of the configured configuration
static long	DEFAULT_LOCAL_TIMEOUT Constant for local default timeout.
static long	DEFAULT_REMOTE_TIMEOUT Constant for remote default timeout.
protected java.lang.Long	defaultTimeout Default platform timeout.
protected IModelInfo	model Platform model.
static java.util.Set<java.lang.String>	RESERVED The reserved platform parameters.

Fields inherited from interface jadex.base.IStarterConfiguration

AUTOSHUTDOWN, COMPONENT, COMPONENT_FACTORY, CONFIGURATION_FILE, CONFIGURATION_NAME, DATA_ADDRESSBOOK, DATA_DEFAULT_LOCAL_TIMEOUT, DATA_DEFAULT_REMOTE_TIMEOUT, DATA_PARAMETERCOPY, DATA_REALTIMETIMEOUT, DATA_SERVICEREGISTRY, DEBUGFUTURES, DEBUGSERVICES, DEBUGSTEPS, DEFTIMEOUT, FALLBACK_COMPONENT_FACTORY, FALLBACK_PLATFORM_CONFIGURATION, MONITORING, NOSTACKCOMPACTION, OPENGL, PERSIST, PLATFORM_COMPONENT, PLATFORM_NAME, REGISTRY_SYNC

Constructor Summary

Constructors

Constructor and Description
StarterConfiguration() Creates an empty configuration.
StarterConfiguration(StarterConfiguration source) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	addComponent(java.lang.Class clazz) Add a component that is started after platform startup.
void	addComponent(java.lang.String path) Add a component that is started after platform startup.
protected void	checkConsistency() Checks this configuration for consistency errors.
void	enhanceWith(StarterConfiguration other) Enhance this config with given other config.
boolean	getAutoShutdown() Get autoshutdown flag.
boolean	getBooleanValue(java.lang.String key) Get the boolean value of a flag.
java.lang.String	getComponentFactory() Get the component factory.
java.util.List<java.lang.String>	getComponents() Get the list of components to be started at startup.
java.lang.String	getConfigurationFile() Get the main configuration file, e.g.
java.lang.String	getConfigurationName() Get the configuration name.
boolean	getDebugFutures() Get the debug futures flag.
boolean	getDebugServices() Get the debug services flag.
boolean	getDebugSteps() Get the debug steps flag.
java.lang.Long	getDefaultTimeout() Gets the default timeout.
long	getLocalDefaultTimeout() Get the default timeout for local calls.
IMonitoringService.PublishEventLevel	getMonitoring() Get the monitoring level.
boolean	getNoStackCompaction() Get the no stack compaction flag.
boolean	getOpenGl() Get the OPENGL flag.
boolean	getPersist() Get the persist flag.
java.lang.Class	getPlatformComponent() Get platform component.
java.lang.String	getPlatformName() Get the platform name.
long	getRemoteDefaultTimeout() Get the default timeout for remote calls.
java.lang.Object	getValue(java.lang.String key) Generic getter for configuration parameters.
void	parseArg(java.lang.String key, java.lang.String stringValue, java.lang.Object value) Parse an argument.
void	setAutoShutdown(boolean value) Set autoshutdown flag.
void	setComponents(java.util.List<java.lang.String> newcomps) Set the list of components to be started at startup.
void	setConfigurationFile(java.lang.String value) Set the main configuration file, e.g.
void	setConfigurationName(java.lang.String value) Set the configuration name.
void	setDebugFutures(boolean value) Set the debug futures flag.
void	setDebugServices(boolean value) Set the debug services flag.
void	setDebugSteps(boolean value) Set the debug steps flag.
void	setDefaultTimeout(long to) Set the default timeout.
void	setMonitoring(IMonitoringService.PublishEventLevel level) Set the monitoring level.
void	setNoStackCompaction(boolean value) Set the no stack compaction flag.
void	setOpenGl(boolean value) Set the OPENGL flag.
void	setPersist(boolean value) Set the persist flag.
void	setPlatformComponent(java.lang.Class value) Set platform component.
void	setPlatformModel(IModelInfo model) Sets the platform model to extract configuration values from it.
void	setPlatformName(java.lang.String value) Set the platform name.
void	setValue(java.lang.String key, java.lang.Object value) Generic setter for cmd args.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REMOTE_TIMEOUT

public static long DEFAULT_REMOTE_TIMEOUT

Constant for remote default timeout.

DEFAULT_LOCAL_TIMEOUT

public static long DEFAULT_LOCAL_TIMEOUT

Constant for local default timeout.

RESERVED

public static final java.util.Set<java.lang.String> RESERVED

The reserved platform parameters. Those are (usually) not handled by the root component.

cmdargs

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

Command line arguments.

components

protected java.util.List<java.lang.String> components

Components to start.

defaultTimeout

protected java.lang.Long defaultTimeout

Default platform timeout.

model

protected IModelInfo model

Platform model. Used to extract default values.

configurationInfo

protected ConfigurationInfo configurationInfo

Name of the configured configuration

Constructor Detail

StarterConfiguration

public StarterConfiguration()

Creates an empty configuration.

StarterConfiguration

public StarterConfiguration(StarterConfiguration source)

Copy constructor.

Method Detail

setPlatformModel

public void setPlatformModel(IModelInfo model)

Sets the platform model to extract configuration values from it.

Specified by:

setPlatformModel in interface IStarterConfiguration

Parameters:

model -

setValue

public void setValue(java.lang.String key,
                     java.lang.Object value)

Generic setter for cmd args.

Parameters:

key -

value -

getValue

public java.lang.Object getValue(java.lang.String key)

Generic getter for configuration parameters. Retrieves values in 3 stages: 1. From given command line arguments. 2. From given model configuration ("auto", "fixed", ...) 3. From model default values. For retrieval from model, setPlatformModel has to be called before.

Parameters:

key -

Returns:

getPlatformName

public java.lang.String getPlatformName()

Get the platform name.

Specified by:

getPlatformName in interface IStarterConfiguration

setPlatformName

public void setPlatformName(java.lang.String value)

Set the platform name.

Specified by:

setPlatformName in interface IStarterConfiguration

getConfigurationName

public java.lang.String getConfigurationName()

Get the configuration name.

Specified by:

getConfigurationName in interface IStarterConfiguration

setConfigurationName

public void setConfigurationName(java.lang.String value)

Set the configuration name.

Specified by:

setConfigurationName in interface IStarterConfiguration

getAutoShutdown

public boolean getAutoShutdown()

Get autoshutdown flag.

Specified by:

getAutoShutdown in interface IStarterConfiguration

setAutoShutdown

public void setAutoShutdown(boolean value)

Set autoshutdown flag.

Specified by:

setAutoShutdown in interface IStarterConfiguration

getPlatformComponent

public java.lang.Class getPlatformComponent()

Get platform component.

Specified by:

getPlatformComponent in interface IStarterConfiguration

setPlatformComponent

public void setPlatformComponent(java.lang.Class value)

Set platform component.

Specified by:

setPlatformComponent in interface IStarterConfiguration

setDefaultTimeout

public void setDefaultTimeout(long to)

Set the default timeout.

Specified by:

setDefaultTimeout in interface IStarterConfiguration

Parameters:

to - timeout in ms.

getDefaultTimeout

public java.lang.Long getDefaultTimeout()

Gets the default timeout.

Specified by:

getDefaultTimeout in interface IStarterConfiguration

Returns:

timeout in ms.

getLocalDefaultTimeout

public long getLocalDefaultTimeout()

Get the default timeout for local calls.

Specified by:

getLocalDefaultTimeout in interface IStarterConfiguration

Returns:

default timeout in ms.

getRemoteDefaultTimeout

public long getRemoteDefaultTimeout()

Get the default timeout for remote calls.

Specified by:

getRemoteDefaultTimeout in interface IStarterConfiguration

Returns:

default timeout in ms.

addComponent

public void addComponent(java.lang.Class clazz)

Add a component that is started after platform startup. DO NOT use this method for starting BDI agents! Pass a fully qualified classname as string to addComponent(String) instead.

Specified by:

addComponent in interface IStarterConfiguration

Parameters:

clazz - Class of the component.

addComponent

public void addComponent(java.lang.String path)

Add a component that is started after platform startup.

Specified by:

addComponent in interface IStarterConfiguration

Parameters:

path - Path to the component.

setComponents

public void setComponents(java.util.List<java.lang.String> newcomps)

Set the list of components to be started at startup.

Specified by:

setComponents in interface IStarterConfiguration

Parameters:

newcomps - List of components.

getComponents

public java.util.List<java.lang.String> getComponents()

Get the list of components to be started at startup.

Specified by:

getComponents in interface IStarterConfiguration

Returns:

List of components

getComponentFactory

public java.lang.String getComponentFactory()

Get the component factory.

Specified by:

getComponentFactory in interface IStarterConfiguration

Returns:

name of component factory

setConfigurationFile

public void setConfigurationFile(java.lang.String value)

Set the main configuration file, e.g. path to PlatformAgent.

Specified by:

setConfigurationFile in interface IStarterConfiguration

Parameters:

value - Path to configuration file

getConfigurationFile

public java.lang.String getConfigurationFile()

Get the main configuration file, e.g. path to PlatformAgent.

Specified by:

getConfigurationFile in interface IStarterConfiguration

Returns:

Path to configuration file

setMonitoring

public void setMonitoring(IMonitoringService.PublishEventLevel level)

Set the monitoring level.

Specified by:

setMonitoring in interface IStarterConfiguration

Parameters:

level -

getMonitoring

public IMonitoringService.PublishEventLevel getMonitoring()

Get the monitoring level.

Specified by:

getMonitoring in interface IStarterConfiguration

Returns:

setPersist

public void setPersist(boolean value)

Set the persist flag.

Specified by:

setPersist in interface IStarterConfiguration

Parameters:

value -

getPersist

public boolean getPersist()

Get the persist flag.

Specified by:

getPersist in interface IStarterConfiguration

Returns:

boolean

setDebugFutures

public void setDebugFutures(boolean value)

Set the debug futures flag.

Specified by:

setDebugFutures in interface IStarterConfiguration

Parameters:

value -

getDebugFutures

public boolean getDebugFutures()

Get the debug futures flag.

Specified by:

getDebugFutures in interface IStarterConfiguration

Returns:

setDebugServices

public void setDebugServices(boolean value)

Set the debug services flag.

Specified by:

setDebugServices in interface IStarterConfiguration

Parameters:

value -

getDebugServices

public boolean getDebugServices()

Get the debug services flag.

Specified by:

getDebugServices in interface IStarterConfiguration

Returns:

setDebugSteps

public void setDebugSteps(boolean value)

Set the debug steps flag.

Specified by:

setDebugSteps in interface IStarterConfiguration

Parameters:

value -

getDebugSteps

public boolean getDebugSteps()

Get the debug steps flag.

Specified by:

getDebugSteps in interface IStarterConfiguration

Returns:

setNoStackCompaction

public void setNoStackCompaction(boolean value)

Set the no stack compaction flag.

Specified by:

setNoStackCompaction in interface IStarterConfiguration

Parameters:

value -

getNoStackCompaction

public boolean getNoStackCompaction()

Get the no stack compaction flag.

Specified by:

getNoStackCompaction in interface IStarterConfiguration

Returns:

True if no stack compaction.

getBooleanValue

public boolean getBooleanValue(java.lang.String key)

Get the boolean value of a flag.

Specified by:

getBooleanValue in interface IStarterConfiguration

setOpenGl

public void setOpenGl(boolean value)

Set the OPENGL flag.

Specified by:

setOpenGl in interface IStarterConfiguration

Parameters:

value -

getOpenGl

public boolean getOpenGl()

Get the OPENGL flag.

Specified by:

getOpenGl in interface IStarterConfiguration

Returns:

enhanceWith

public void enhanceWith(StarterConfiguration other)

Enhance this config with given other config. Will overwrite all values that are set in the other config.

Parameters:

other -

parseArg

public void parseArg(java.lang.String key,
                     java.lang.String stringValue,
                     java.lang.Object value)

Parse an argument.

Parameters:

key - The key.

stringValue - The value.

checkConsistency

protected void checkConsistency()

Checks this configuration for consistency errors.