org.openksavi.sponge.core.engine

Class DefaultConfigurationManager

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.DefaultConfigurationManager

All Implemented Interfaces:

ConfigurationManager, EngineModule, Descriptive, HasEngine, Manageable

public class DefaultConfigurationManager
extends BaseEngineModule
implements ConfigurationManager

Default configuration manager. It contains methods for accessing configuration parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<KnowledgeBase>	postConfigKnowledgeBases Knowledge bases added manually after the config file.
protected List<Plugin>	postConfigPlugins Plugins added manually after the config file.
protected List<KnowledgeBase>	preConfigKnowledgeBases Knowledge bases added manually before the config file.
protected List<Plugin>	preConfigPlugins Plugins added manually before the config file.

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationManager(SpongeEngine engine, String configurationFilename) Creates a new configuration manager.

Method Summary

Modifier and Type	Method and Description
void	addPostConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases)
void	addPostConfigPlugins(List<Plugin> plugins)
void	addPreConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases)
void	addPreConfigPlugins(List<Plugin> plugins)
protected org.apache.commons.lang3.tuple.Triple<org.apache.commons.configuration2.XMLConfiguration,URL,org.apache.commons.configuration2.PropertiesConfiguration>	createXmlConfiguration(String filename)
void	doStartup() Starts up this managed entity.
int	getAsyncEventSetProcessorExecutorThreadCount()
boolean	getAutoEnable()
URL	getConfigurationFileUrl()
int	getDurationThreadCount()
Configuration	getEngineConfig() Returns the engine configuration.
String	getEngineDescription()
String	getEngineLabel()
String	getEngineLicense()
String	getEngineName()
EventClonePolicy	getEventClonePolicy() Return event clone policy.
int	getEventQueueCapacity() Returns the event queue capacity.
boolean	getEventSetProcessorDefaultSynchronous()
long	getExecutorShutdownTimeout()
String	getHome() Returns the engine home directory.
int	getMainProcessingUnitThreadCount() Returns the number of the Main Processing Unit worker threads.
List<KnowledgeBase>	getPostConfigKnowledgeBases()
List<Plugin>	getPostConfigPlugins()
List<KnowledgeBase>	getPreConfigKnowledgeBases()
List<Plugin>	getPreConfigPlugins()
String	getProperty(String name)
Configuration	getRootConfig() Returns the root configuration.
protected void	readConfiguration()
protected void	resolveHome()
void	setAsyncEventSetProcessorExecutorThreadCount(int asyncEventSetProcessorExecutorThreadCount)
void	setAutoEnable(boolean autoEnable)
void	setDurationThreadCount(int durationThreadCount)
void	setEngineDescription(String engineDescription)
void	setEngineLabel(String engineLabel)
void	setEngineLicense(String engineLicense)
void	setEngineName(String engineName)
void	setEventClonePolicy(EventClonePolicy eventClonePolicy)
void	setEventQueueCapacity(int eventQueueCapacity)
void	setEventSetProcessorDefaultSynchronous(boolean eventSetProcessorDefaultSynchronous)
void	setExecutorShutdownTimeout(long executorShutdownTimeout)
void	setMainProcessingUnitThreadCount(int mainProcessingUnitThreadCount)
void	setProperties(Map<String,Object> properties)
void	setProperty(String key, Object value)
void	setProperty(String key, Object value, boolean variable, boolean system)
void	setPropertyEntries(Map<String,PropertyEntry> propertyEntries)
void	setSystemProperties(Map<String,String> systemProperties)
void	setSystemProperty(String key, Object value)
void	setVariableProperties(Map<String,String> variableProperties)
void	setVariableProperty(String key, Object value)
String	toString()

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

doShutdown, getDescription, getEngine, getInternalService, getLabel, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setEngine, setLabel, setName, shutdown, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Field Detail

preConfigPlugins

protected List<Plugin> preConfigPlugins

Plugins added manually before the config file.

postConfigPlugins

protected List<Plugin> postConfigPlugins

Plugins added manually after the config file.

preConfigKnowledgeBases

protected List<KnowledgeBase> preConfigKnowledgeBases

Knowledge bases added manually before the config file.

postConfigKnowledgeBases

protected List<KnowledgeBase> postConfigKnowledgeBases

Knowledge bases added manually after the config file.

Constructor Detail

DefaultConfigurationManager

public DefaultConfigurationManager(SpongeEngine engine,
                                   String configurationFilename)

Creates a new configuration manager.

Parameters:

engine - the engine.

configurationFilename - configuration filename.

Method Detail

doStartup

public void doStartup()

Starts up this managed entity.

Overrides:

doStartup in class BaseEngineModule

createXmlConfiguration

protected org.apache.commons.lang3.tuple.Triple<org.apache.commons.configuration2.XMLConfiguration,URL,org.apache.commons.configuration2.PropertiesConfiguration> createXmlConfiguration(String filename)

readConfiguration

protected void readConfiguration()

getRootConfig

public Configuration getRootConfig()

Returns the root configuration.

Specified by:

getRootConfig in interface ConfigurationManager

Returns:

the root configuration.

getEngineConfig

public Configuration getEngineConfig()

Returns the engine configuration.

Specified by:

getEngineConfig in interface ConfigurationManager

Returns:

the engine configuration.

getEngineName

public String getEngineName()

Specified by:

getEngineName in interface ConfigurationManager

setEngineName

public void setEngineName(String engineName)

Specified by:

setEngineName in interface ConfigurationManager

getEngineLabel

public String getEngineLabel()

Specified by:

getEngineLabel in interface ConfigurationManager

setEngineLabel

public void setEngineLabel(String engineLabel)

Specified by:

setEngineLabel in interface ConfigurationManager

getEngineDescription

public String getEngineDescription()

Specified by:

getEngineDescription in interface ConfigurationManager

setEngineDescription

public void setEngineDescription(String engineDescription)

Specified by:

setEngineDescription in interface ConfigurationManager

getEngineLicense

public String getEngineLicense()

Specified by:

getEngineLicense in interface ConfigurationManager

setEngineLicense

public void setEngineLicense(String engineLicense)

Specified by:

setEngineLicense in interface ConfigurationManager

getMainProcessingUnitThreadCount

public int getMainProcessingUnitThreadCount()

Returns the number of the Main Processing Unit worker threads.

Specified by:

getMainProcessingUnitThreadCount in interface ConfigurationManager

Returns:

the number of the Main Processing Unit worker threads.

getEventQueueCapacity

public int getEventQueueCapacity()

Returns the event queue capacity.

Specified by:

getEventQueueCapacity in interface ConfigurationManager

Returns:

the event queue capacity.

getDurationThreadCount

public int getDurationThreadCount()

Specified by:

getDurationThreadCount in interface ConfigurationManager

getAsyncEventSetProcessorExecutorThreadCount

public int getAsyncEventSetProcessorExecutorThreadCount()

Specified by:

getAsyncEventSetProcessorExecutorThreadCount in interface ConfigurationManager

getEventClonePolicy

public EventClonePolicy getEventClonePolicy()

Return event clone policy.

Specified by:

getEventClonePolicy in interface ConfigurationManager

Returns:

eventClonePolicy

getExecutorShutdownTimeout

public long getExecutorShutdownTimeout()

Specified by:

getExecutorShutdownTimeout in interface ConfigurationManager

getHome

public String getHome()

Returns the engine home directory.

Specified by:

getHome in interface ConfigurationManager

Returns:

the engine home directory.

resolveHome

protected void resolveHome()

getConfigurationFileUrl

public URL getConfigurationFileUrl()

Specified by:

getConfigurationFileUrl in interface ConfigurationManager

toString

public String toString()

Overrides:

toString in class BaseEngineModule

getProperty

public String getProperty(String name)

Specified by:

getProperty in interface ConfigurationManager

setEventClonePolicy

public void setEventClonePolicy(EventClonePolicy eventClonePolicy)

Specified by:

setEventClonePolicy in interface ConfigurationManager

setMainProcessingUnitThreadCount

public void setMainProcessingUnitThreadCount(int mainProcessingUnitThreadCount)

Specified by:

setMainProcessingUnitThreadCount in interface ConfigurationManager

setEventQueueCapacity

public void setEventQueueCapacity(int eventQueueCapacity)

Specified by:

setEventQueueCapacity in interface ConfigurationManager

setDurationThreadCount

public void setDurationThreadCount(int durationThreadCount)

Specified by:

setDurationThreadCount in interface ConfigurationManager

setAsyncEventSetProcessorExecutorThreadCount

public void setAsyncEventSetProcessorExecutorThreadCount(int asyncEventSetProcessorExecutorThreadCount)

Specified by:

setAsyncEventSetProcessorExecutorThreadCount in interface ConfigurationManager

setExecutorShutdownTimeout

public void setExecutorShutdownTimeout(long executorShutdownTimeout)

Specified by:

setExecutorShutdownTimeout in interface ConfigurationManager

setProperty

public void setProperty(String key,
                        Object value,
                        boolean variable,
                        boolean system)

Specified by:

setProperty in interface ConfigurationManager

setProperty

public void setProperty(String key,
                        Object value)

Specified by:

setProperty in interface ConfigurationManager

setSystemProperty

public void setSystemProperty(String key,
                              Object value)

Specified by:

setSystemProperty in interface ConfigurationManager

setVariableProperty

public void setVariableProperty(String key,
                                Object value)

Specified by:

setVariableProperty in interface ConfigurationManager

setProperties

public void setProperties(Map<String,Object> properties)

Specified by:

setProperties in interface ConfigurationManager

setSystemProperties

public void setSystemProperties(Map<String,String> systemProperties)

Specified by:

setSystemProperties in interface ConfigurationManager

setVariableProperties

public void setVariableProperties(Map<String,String> variableProperties)

Specified by:

setVariableProperties in interface ConfigurationManager

setPropertyEntries

public void setPropertyEntries(Map<String,PropertyEntry> propertyEntries)

Specified by:

setPropertyEntries in interface ConfigurationManager

getEventSetProcessorDefaultSynchronous

public boolean getEventSetProcessorDefaultSynchronous()

Specified by:

getEventSetProcessorDefaultSynchronous in interface ConfigurationManager

setEventSetProcessorDefaultSynchronous

public void setEventSetProcessorDefaultSynchronous(boolean eventSetProcessorDefaultSynchronous)

Specified by:

setEventSetProcessorDefaultSynchronous in interface ConfigurationManager

getAutoEnable

public boolean getAutoEnable()

Specified by:

getAutoEnable in interface ConfigurationManager

setAutoEnable

public void setAutoEnable(boolean autoEnable)

Specified by:

setAutoEnable in interface ConfigurationManager

getPreConfigPlugins

public List<Plugin> getPreConfigPlugins()

Specified by:

getPreConfigPlugins in interface ConfigurationManager

getPostConfigPlugins

public List<Plugin> getPostConfigPlugins()

Specified by:

getPostConfigPlugins in interface ConfigurationManager

addPreConfigPlugins

public void addPreConfigPlugins(List<Plugin> plugins)

Specified by:

addPreConfigPlugins in interface ConfigurationManager

addPostConfigPlugins

public void addPostConfigPlugins(List<Plugin> plugins)

Specified by:

addPostConfigPlugins in interface ConfigurationManager

getPreConfigKnowledgeBases

public List<KnowledgeBase> getPreConfigKnowledgeBases()

Specified by:

getPreConfigKnowledgeBases in interface ConfigurationManager

getPostConfigKnowledgeBases

public List<KnowledgeBase> getPostConfigKnowledgeBases()

Specified by:

getPostConfigKnowledgeBases in interface ConfigurationManager

addPreConfigKnowledgeBases

public void addPreConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases)

Specified by:

addPreConfigKnowledgeBases in interface ConfigurationManager

addPostConfigKnowledgeBases

public void addPostConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases)

Specified by:

addPostConfigKnowledgeBases in interface ConfigurationManager