jadex.base

Class AbstractPlatformConfiguration

java.lang.Object

jadex.base.AbstractPlatformConfiguration

All Implemented Interfaces:

IRootComponentConfiguration, IStarterConfiguration

Direct Known Subclasses:

PlatformConfiguration

public abstract class AbstractPlatformConfiguration
extends java.lang.Object
implements IStarterConfiguration, IRootComponentConfiguration

Nested Class Summary

Nested classes/interfaces inherited from interface jadex.base.IRootComponentConfiguration

IRootComponentConfiguration.AWAMECHANISM, IRootComponentConfiguration.KERNEL

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FACTORY
protected static java.util.Map<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>>	platformmem Global platform data.

Fields inherited from interface jadex.base.IStarterConfiguration

AUTOSHUTDOWN, COMPONENT, 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

Fields inherited from interface jadex.base.IRootComponentConfiguration

ADDRESS, ASYNCEXECUTION, AWADELAY, AWAEXCLUDES, AWAFAST, AWAINCLUDES, AWAMECHANISMS, AWARENESS, BASECLASSLOADER, BINARYMESSAGES, BOOLEAN_ARGS, CHAT, CLI, CLICONSOLE, CLOCK, CONTEXT, CONTEXTSERVICECLASS, DF, FILETRANSFER, GUI, JCCPLATFORMS, KERNELS, LIBPATH, LIBRARY, LOCALTRANSPORT, LOGGING, LOGGING_LEVEL, MARSHAL, MAVEN_DEPENDENCIES, MESSAGE, MONITORINGCOMP, NETWORKNAME, NETWORKPASS, NIOTCPPORT, NIOTCPTRANSPORT, PERSIST, PLATFORM_ACCESS, PRINTPASS, PROGRAM_ARGUMENTS, REGISTRY_SYNC, RELAYADDRESS, RELAYAWAONLY, RELAYSECURITY, RELAYTRANSPORT, RSPUBLISH, RSPUBLISHCOMPONENT, SAVEONEXIT, SECURITY, SENSORS, SETTINGS, SIMUL, SIMULATION, SSLTCPPORT, SSLTCPTRANSPORT, STRICTCOM, TCPPORT, TCPTRANSPORT, THREADPOOLCLASS, THREADPOOLDEFER, TRUSTEDLAN, UNIQUEIDS, USEPASS, VALIDITYDURATION, VIRTUALNAMES, WELCOME, WSPUBLISH

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractPlatformConfiguration()
	AbstractPlatformConfiguration(AbstractPlatformConfiguration config) Copy constructor.
protected	AbstractPlatformConfiguration(java.lang.String[] args) Constructor that creates a new Configuration based on an args object.

Method Summary

Modifier and Type	Method and Description
protected void	checkConsistency() Checks this configuration for consistency errors.
void	enhanceWith(PlatformConfiguration other) Enhance this config with given other config.
static PlatformConfiguration	getAndroidDefault() Returns a PlatformConfiguration with the default parameters.
static PlatformConfiguration	getDefault() Returns a PlatformConfiguration with the default parameters.
static PlatformConfiguration	getDefaultNoGui() Returns a PlatformConfiguration with the default parameters but without gui.
static long	getLocalDefaultTimeout(IComponentIdentifier platform) Get the local default timeout.
static PlatformConfiguration	getMinimal() Returns a minimal platform configuration without any network connectivity.
static PlatformConfiguration	getMinimalRelayAwareness() Returns a minimal platform configuration that communicates via relay.
static java.lang.Object	getPlatformValue(IComponentIdentifier platform, java.lang.String key) Get a global platform value.
static long	getRemoteDefaultTimeout(IComponentIdentifier platform) Get the remote default timeout.
RootComponentConfiguration	getRootConfig() Returns the configuration of the root component.
static long	getScaledLocalDefaultTimeout(IComponentIdentifier platform, double scale) Get the scaled local default timeout.
static long	getScaledRemoteDefaultTimeout(IComponentIdentifier platform, double scale) Get the scaled remote default timeout.
StarterConfiguration	getStarterConfig() Returns the configuration of the root component.
static boolean	hasPlatformValue(IComponentIdentifier platform, java.lang.String key) Get a global platform value.
static boolean	isParameterCopy(IComponentIdentifier platform) Check if the parameter copy flag is set for a platform.
static boolean	isRealtimeTimeout(IComponentIdentifier platform) Check if the real time timeout flag is set for a platform.
void	parseArg(java.lang.String key, java.lang.String val)
static void	parseArg(java.lang.String okey, java.lang.String val, AbstractPlatformConfiguration config)
void	parseArgs(java.lang.String[] args)
static void	parseArgs(java.lang.String[] args, AbstractPlatformConfiguration config)
static PlatformConfiguration	processArgs(java.util.Map<java.lang.String,java.lang.String> args) Deprecated. since 3.0.7. Use other processArgs methods instead.
static PlatformConfiguration	processArgs(java.lang.String args) Create a platform configuration.
static PlatformConfiguration	processArgs(java.lang.String[] args) Create a platform configuration.
static void	putPlatformValue(IComponentIdentifier platform, java.lang.String key, java.lang.Object value) Get a global platform value.
static void	removePlatformMemory(IComponentIdentifier platform) Get a global platform value.
static void	setLocalDefaultTimeout(IComponentIdentifier platform, long timeout) Set the local default timeout.
void	setPlatformModel(IModelInfo model) Sets the platform model to extract configuration values from it.
static void	setRemoteDefaultTimeout(IComponentIdentifier platform, long timeout) Set the remote default timeout.
void	setValue(java.lang.String key, java.lang.Object value) Set a value to both configs, not recommended.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.base.IStarterConfiguration

addComponent, addComponent, getAutoShutdown, getBooleanValue, getComponentFactory, getComponents, getConfigurationFile, getConfigurationName, getDebugFutures, getDebugServices, getDebugSteps, getDefaultTimeout, getLocalDefaultTimeout, getMonitoring, getNoStackCompaction, getOpenGl, getPersist, getPlatformComponent, getPlatformName, getRemoteDefaultTimeout, setAutoShutdown, setComponents, setConfigurationFile, setConfigurationName, setDebugFutures, setDebugServices, setDebugSteps, setDefaultTimeout, setMonitoring, setNoStackCompaction, setOpenGl, setPersist, setPlatformComponent, setPlatformName

Methods inherited from interface jadex.base.IRootComponentConfiguration

getAddress, getArgs, getAsyncExecution, getAwaDelay, getAwaExcludes, getAwaIncludes, getAwaMechanisms, getAwareness, getBaseClassloader, getBinaryMessages, getChat, getCli, getCliConsole, getClock, getContext, getContextServiceClass, getDf, getFiletransfer, getGui, getJccPlatforms, getKernels, getLibPath, getLibrary, getLocalTransport, getLogging, getLoggingLevel, getMarshal, getMavenDependencies, getMessage, getMonitoringComp, getNetworkName, getNetworkPass, getNioTcpPort, getNioTcpTransport, getPersist, getPrintPass, getRegistrySync, getRelayAddress, getRelayAwaonly, getRelaySecurity, getRelayTransport, getRsPublish, getRsPublishComponent, getSaveOnExit, getSecurity, getSensors, getSettings, getSimul, getSimulation, getSslTcpPort, getSslTcpTransport, getStrictCom, getTcpPort, getTcpTransport, getThreadpoolClass, getThreadpoolDefer, getTrustedLan, getUniqueIds, getUsePass, getValidityDuration, getVirtualNames, getWelcome, getWsPublish, isAwaFast, setAddress, setAsyncExecution, setAwaDelay, setAwaExcludes, setAwaFast, setAwaIncludes, setAwaMechanisms, setAwareness, setBaseClassloader, setBinaryMessages, setChat, setCli, setCliConsole, setClock, setComponentFactory, setContext, setContextServiceClass, setDf, setFiletransfer, setGui, setJccPlatforms, setKernels, setKernels, setLibPath, setLibrary, setLocalTransport, setLogging, setLoggingLevel, setMarshal, setMavenDependencies, setMessage, setMonitoringComp, setNetworkName, setNetworkPass, setNioTcpPort, setNioTcpTransport, setPersist, setPlatformAccess, setPrintPass, setProgramArguments, setRegistrySync, setRelayAddress, setRelayAwaonly, setRelaySecurity, setRelayTransport, setRsPublish, setRsPublishComponent, setSaveOnExit, setSecurity, setSensors, setSettings, setSimul, setSimulation, setSslTcpPort, setSslTcpTransport, setStrictCom, setTcpPort, setTcpTransport, setThreadpoolClass, setThreadpoolDefer, setTrustedLan, setUniqueIds, setUsePass, setValidityDuration, setVirtualNames, setWelcome, setWsPublish

Field Detail

platformmem

protected static final java.util.Map<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>> platformmem

Global platform data.

COMPONENT_FACTORY

public static final java.lang.String COMPONENT_FACTORY

See Also:

Constant Field Values

Constructor Detail

AbstractPlatformConfiguration

public AbstractPlatformConfiguration()

AbstractPlatformConfiguration

protected AbstractPlatformConfiguration(java.lang.String[] args)

Constructor that creates a new Configuration based on an args object. (which can be a Map or a String array). Does not parse the args - no public use!

Parameters:

args -

AbstractPlatformConfiguration

public AbstractPlatformConfiguration(AbstractPlatformConfiguration config)

Copy constructor.

Parameters:

config - AbstractPlatformConfiguration

Method Detail

getDefault

public static PlatformConfiguration getDefault()

Returns a PlatformConfiguration with the default parameters.

Returns:

getDefaultNoGui

public static PlatformConfiguration getDefaultNoGui()

Returns a PlatformConfiguration with the default parameters but without gui.

Returns:

getAndroidDefault

public static PlatformConfiguration getAndroidDefault()

Returns a PlatformConfiguration with the default parameters.

Returns:

getMinimal

public static PlatformConfiguration getMinimal()

Returns a minimal platform configuration without any network connectivity.

Returns:

getMinimalRelayAwareness

public static PlatformConfiguration getMinimalRelayAwareness()

Returns a minimal platform configuration that communicates via relay.

Returns:

getRootConfig

public RootComponentConfiguration getRootConfig()

Returns the configuration of the root component.

Returns:

RootComponentConfiguration

getStarterConfig

public StarterConfiguration getStarterConfig()

Returns the configuration of the root component.

Returns:

RootComponentConfiguration

processArgs

public static PlatformConfiguration processArgs(java.lang.String args)

Create a platform configuration.

Parameters:

args - The command line arguments.

Returns:

StarterConfiguration

processArgs

public static PlatformConfiguration processArgs(java.lang.String[] args)

Create a platform configuration.

Parameters:

args - The command line arguments.

Returns:

StarterConfiguration

processArgs

@Deprecated
public static PlatformConfiguration processArgs(java.util.Map<java.lang.String,java.lang.String> args)

Deprecated. since 3.0.7. Use other processArgs methods instead.

Create a platform configuration.

Parameters:

args - The command line arguments.

Returns:

StarterConfiguration

parseArgs

public void parseArgs(java.lang.String[] args)

parseArg

public void parseArg(java.lang.String key,
                     java.lang.String val)

parseArgs

public static void parseArgs(java.lang.String[] args,
                             AbstractPlatformConfiguration config)

parseArg

public static void parseArg(java.lang.String okey,
                            java.lang.String val,
                            AbstractPlatformConfiguration config)

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)

Set a value to both configs, not recommended. Use specific methods instead.

Parameters:

key -

value -

getPlatformValue

public static java.lang.Object getPlatformValue(IComponentIdentifier platform,
                                                java.lang.String key)

Get a global platform value.

Parameters:

platform - The platform name.

key - The key.

Returns:

The value.

putPlatformValue

public static void putPlatformValue(IComponentIdentifier platform,
                                    java.lang.String key,
                                    java.lang.Object value)

Get a global platform value.

Parameters:

platform - The platform name.

key - The key.

value - The value.

hasPlatformValue

public static boolean hasPlatformValue(IComponentIdentifier platform,
                                       java.lang.String key)

Get a global platform value.

Parameters:

platform - The platform name.

key - The key.

Returns:

The value.

removePlatformMemory

public static void removePlatformMemory(IComponentIdentifier platform)

Get a global platform value.

Parameters:

platform - The platform name.

getRemoteDefaultTimeout

public static long getRemoteDefaultTimeout(IComponentIdentifier platform)

Get the remote default timeout.

getScaledRemoteDefaultTimeout

public static long getScaledRemoteDefaultTimeout(IComponentIdentifier platform,
                                                 double scale)

Get the scaled remote default timeout.

getLocalDefaultTimeout

public static long getLocalDefaultTimeout(IComponentIdentifier platform)

Get the local default timeout.

getScaledLocalDefaultTimeout

public static long getScaledLocalDefaultTimeout(IComponentIdentifier platform,
                                                double scale)

Get the scaled local default timeout.

setRemoteDefaultTimeout

public static void setRemoteDefaultTimeout(IComponentIdentifier platform,
                                           long timeout)

Set the remote default timeout.

setLocalDefaultTimeout

public static void setLocalDefaultTimeout(IComponentIdentifier platform,
                                          long timeout)

Set the local default timeout.

isRealtimeTimeout

public static boolean isRealtimeTimeout(IComponentIdentifier platform)

Check if the real time timeout flag is set for a platform.

isParameterCopy

public static boolean isParameterCopy(IComponentIdentifier platform)

Check if the parameter copy flag is set for a platform.

checkConsistency

protected void checkConsistency()

Checks this configuration for consistency errors.

enhanceWith

public void enhanceWith(PlatformConfiguration other)

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

Parameters:

other -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object