org.openksavi.sponge.engine

Interface ConfigurationManager

All Superinterfaces:

Descriptive, EngineModule, HasEngine, Manageable

public interface ConfigurationManager
extends EngineModule

Configuration manager interface. It contains methods for accessing configuration parameters.

Method Summary

Modifier and Type	Method and Description
void	addPostConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases) Adds knowledge bases to the list of post-config knowledge bases.
void	addPostConfigPlugins(List<Plugin> plugins) Adds plugins to the list of post-config plugins.
void	addPreConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases) Adds knowledge bases to the list of pre-config knowledge bases.
void	addPreConfigPlugins(List<Plugin> plugins) Adds plugins to the list of pre-config plugins.
int	getAsyncEventSetProcessorExecutorThreadCount() Returns the number of threads used by an event set processor asynchronous executor.
boolean	getAutoEnable() Returns true if auto-enable of processors is turned on.
URL	getConfigurationFileUrl() Returns the configuration file URL.
int	getDurationThreadCount() Returns the number of threads used by a duration executor.
Configuration	getEngineConfig() Returns the engine configuration.
String	getEngineDescription() Returns the engine description.
String	getEngineLabel() Returns the engine label.
String	getEngineLicense() Returns the engine license.
String	getEngineName() Returns the engine name.
EventClonePolicy	getEventClonePolicy() Return event clone policy.
int	getEventQueueCapacity() Returns the event queue capacity.
boolean	getEventSetProcessorDefaultSynchronous() Return an event set processor default synchronous flag.
long	getExecutorShutdownTimeout() Returns an executor shutdown timeout (in milliseconds).
String	getHome() Returns the home directory for this engine.
int	getMainProcessingUnitThreadCount() Returns the number of the Main Processing Unit worker threads.
List<KnowledgeBase>	getPostConfigKnowledgeBases() Returns post-config knowledge bases added in the EngineBuilder.
List<Plugin>	getPostConfigPlugins() Returns post-config plugins added in the EngineBuilder.
List<KnowledgeBase>	getPreConfigKnowledgeBases() Returns pre-config knowledge bases added in the EngineBuilder.
List<Plugin>	getPreConfigPlugins() Returns pre-config plugins added in the EngineBuilder.
String	getProperty(String name) Returns the property value or null if there is none.
Configuration	getRootConfig() Returns the root configuration.
void	setAsyncEventSetProcessorExecutorThreadCount(int asyncEventSetProcessorExecutorThreadCount) Sets the number of threads used by an event set processor asynchronous executor.
void	setAutoEnable(boolean autoEnable) Sets auto-enable of processors.
void	setDurationThreadCount(int durationThreadCount) Sets duration executor thread count.
void	setEngineDescription(String engineDescription) Sets the engine description.
void	setEngineLabel(String engineLabel) Sets the engine label.
void	setEngineLicense(String engineLicense) Sets the engine license.
void	setEngineName(String engineName) Sets the engine name.
void	setEventClonePolicy(EventClonePolicy eventClonePolicy) Sets event clone policy.
void	setEventQueueCapacity(int eventQueueCapacity) Sets event queue capacity.
void	setEventSetProcessorDefaultSynchronous(boolean eventSetProcessorDefaultSynchronous) Sets an event set processor default synchronous flag.
void	setExecutorShutdownTimeout(long executorShutdownTimeout) Sets an executor shutdown timeout (in milliseconds).
void	setMainProcessingUnitThreadCount(int mainProcessingUnitThreadCount) Sets the number of the Main Processing Unit worker threads.
void	setProperties(Map<String,Object> properties) Sets properties.
void	setProperty(String key, Object value) Sets property.
void	setProperty(String key, Object value, boolean variable, boolean system) Sets property.
void	setPropertyEntries(Map<String,PropertyEntry> propertyEntries) Sets property entries.
void	setSystemProperties(Map<String,String> systemProperties) Sets system properties.
void	setSystemProperty(String key, Object value) Sets a property that is also a system property.
void	setVariableProperties(Map<String,String> variableProperties) Sets variable properties.
void	setVariableProperty(String key, Object value) Sets a property that is also an engine scope variable.

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

Method Detail

getProperty

String getProperty(String name)

Returns the property value or null if there is none.

Parameters:

name - the property name.

Returns:

the property value.

getRootConfig

Configuration getRootConfig()

Returns the root configuration.

Returns:

the root configuration.

getEngineConfig

Configuration getEngineConfig()

Returns the engine configuration.

Returns:

the engine configuration.

getHome

String getHome()

Returns the home directory for this engine.

Returns:

the home directory for this engine.

getConfigurationFileUrl

URL getConfigurationFileUrl()

Returns the configuration file URL. This method should be used only after reading the configuration.

Returns:

the configuration file URL or null if there is no configuration file.

getEngineName

String getEngineName()

Returns the engine name.

Returns:

the engine name.

setEngineName

void setEngineName(String engineName)

Sets the engine name.

Parameters:

engineName - the engine name.

getEngineLabel

String getEngineLabel()

Returns the engine label.

Returns:

the engine label.

setEngineLabel

void setEngineLabel(String engineLabel)

Sets the engine label.

Parameters:

engineLabel - the engine label.

getEngineDescription

String getEngineDescription()

Returns the engine description.

Returns:

the engine description.

setEngineDescription

void setEngineDescription(String engineDescription)

Sets the engine description.

Parameters:

engineDescription - the engine description.

getEngineLicense

String getEngineLicense()

Returns the engine license.

Returns:

the engine license.

setEngineLicense

void setEngineLicense(String engineLicense)

Sets the engine license.

Parameters:

engineLicense - the engine license.

getMainProcessingUnitThreadCount

int getMainProcessingUnitThreadCount()

Returns the number of the Main Processing Unit worker threads.

Returns:

the number of the Main Processing Unit worker threads.

getEventQueueCapacity

int getEventQueueCapacity()

Returns the event queue capacity.

Returns:

the event queue capacity.

getDurationThreadCount

int getDurationThreadCount()

Returns the number of threads used by a duration executor.

Returns:

the number of threads used by a duration executor.

getAsyncEventSetProcessorExecutorThreadCount

int getAsyncEventSetProcessorExecutorThreadCount()

Returns the number of threads used by an event set processor asynchronous executor.

Returns:

the number of threads used by an event set processor asynchronous executor.

getEventClonePolicy

EventClonePolicy getEventClonePolicy()

Return event clone policy.

Returns:

eventClonePolicy

getEventSetProcessorDefaultSynchronous

boolean getEventSetProcessorDefaultSynchronous()

Return an event set processor default synchronous flag.

Returns:

an event set processor default synchronous flag.

getAutoEnable

boolean getAutoEnable()

Returns true if auto-enable of processors is turned on.

Returns:

true if auto-enable of processors is turned on.

getExecutorShutdownTimeout

long getExecutorShutdownTimeout()

Returns an executor shutdown timeout (in milliseconds).

Returns:

an executor shutdown timeout.

setMainProcessingUnitThreadCount

void setMainProcessingUnitThreadCount(int mainProcessingUnitThreadCount)

Sets the number of the Main Processing Unit worker threads.

Parameters:

mainProcessingUnitThreadCount - the number of the Main Processing Unit worker threads.

setEventSetProcessorDefaultSynchronous

void setEventSetProcessorDefaultSynchronous(boolean eventSetProcessorDefaultSynchronous)

Sets an event set processor default synchronous flag.

Parameters:

eventSetProcessorDefaultSynchronous - an event set processor default synchronous flag.

setEventClonePolicy

void setEventClonePolicy(EventClonePolicy eventClonePolicy)

Sets event clone policy.

Parameters:

eventClonePolicy - event clone policy.

setEventQueueCapacity

void setEventQueueCapacity(int eventQueueCapacity)

Sets event queue capacity.

Parameters:

eventQueueCapacity - event queue capacity.

setDurationThreadCount

void setDurationThreadCount(int durationThreadCount)

Sets duration executor thread count.

Parameters:

durationThreadCount - duration executor thread count.

setAsyncEventSetProcessorExecutorThreadCount

void setAsyncEventSetProcessorExecutorThreadCount(int asyncEventSetProcessorExecutorThreadCount)

Sets the number of threads used by an event set processor asynchronous executor.

Parameters:

asyncEventSetProcessorExecutorThreadCount - the number of threads used by an event set processor asynchronous executor.

setProperty

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

Sets property.

Parameters:

key - property key.

value - property value.

variable - should this property be set as a variable.

system - is a system property.

setProperty

void setProperty(String key,
                 Object value)

Sets property.

Parameters:

key - property key.

value - property value.

setSystemProperty

void setSystemProperty(String key,
                       Object value)

Sets a property that is also a system property.

Parameters:

key - property key.

value - property value.

setVariableProperty

void setVariableProperty(String key,
                         Object value)

Sets a property that is also an engine scope variable.

Parameters:

key - property key.

value - property value.

setProperties

void setProperties(Map<String,Object> properties)

Sets properties.

Parameters:

properties - property map.

setPropertyEntries

void setPropertyEntries(Map<String,PropertyEntry> propertyEntries)

Sets property entries.

Parameters:

propertyEntries - property entries.

setSystemProperties

void setSystemProperties(Map<String,String> systemProperties)

Sets system properties.

Parameters:

systemProperties - system property map.

setVariableProperties

void setVariableProperties(Map<String,String> variableProperties)

Sets variable properties.

Parameters:

variableProperties - variable property map.

setAutoEnable

void setAutoEnable(boolean autoEnable)

Sets auto-enable of processors.

Parameters:

autoEnable - auto-enable of processors.

setExecutorShutdownTimeout

void setExecutorShutdownTimeout(long executorShutdownTimeout)

Sets an executor shutdown timeout (in milliseconds).

Parameters:

executorShutdownTimeout - an executor shutdown timeout.

getPreConfigPlugins

List<Plugin> getPreConfigPlugins()

Returns pre-config plugins added in the EngineBuilder.

Returns:

the pre-config plugins.

getPostConfigPlugins

List<Plugin> getPostConfigPlugins()

Returns post-config plugins added in the EngineBuilder.

Returns:

the post-config plugins.

addPreConfigPlugins

void addPreConfigPlugins(List<Plugin> plugins)

Adds plugins to the list of pre-config plugins.

Parameters:

plugins - a list of pre-config plugins.

addPostConfigPlugins

void addPostConfigPlugins(List<Plugin> plugins)

Adds plugins to the list of post-config plugins.

Parameters:

plugins - a list of post-config plugins.

getPreConfigKnowledgeBases

List<KnowledgeBase> getPreConfigKnowledgeBases()

Returns pre-config knowledge bases added in the EngineBuilder.

Returns:

the pre-config knowledge bases.

getPostConfigKnowledgeBases

List<KnowledgeBase> getPostConfigKnowledgeBases()

Returns post-config knowledge bases added in the EngineBuilder.

Returns:

the post-config knowledge bases.

addPreConfigKnowledgeBases

void addPreConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases)

Adds knowledge bases to the list of pre-config knowledge bases.

Parameters:

knowledgeBases - a list of pre-config knowledge bases.

addPostConfigKnowledgeBases

void addPostConfigKnowledgeBases(List<KnowledgeBase> knowledgeBases)

Adds knowledge bases to the list of post-config knowledge bases.

Parameters:

knowledgeBases - a list of post-config knowledge bases.