Skip navigation links

ilog.rules.dvs.common.input
Interface IlrScenarioSuiteDescriptor

All Superinterfaces:

Serializable

public interface IlrScenarioSuiteDescriptor
extends Serializable

Encapsulates the input resources needed for an SSP run. Instances of this class are used by SSP client applications to prepare the data to be used. The server receives these instances and retrieves the appropriate information to handle the job.

Various types of resources can be added to an IlrScenarioSuiteDescriptor instance. For example, binary data and strings. Instances of this class are created using an instance of IlrScenarioSuiteDescriptorFactory.

Since:

7.0

Method Summary

void	add(String name, Serializable value) Adds a resource with a given name.
Serializable	get(String identifier) Returns the resource for an identifier.
IlrScenarioFormatDescriptor	getFormatDescriptor() Returns the format descriptor.
Locale	getLocale() Returns the locale.
IlrRulesetArchive	getProductionRulesetArchive() Returns the production (tested) ruleset archive.
Map<String,String>	getProductionRulesetProperties() Returns the production (tested) ruleset properties.
String	getResPassword() Returns the password used to connect to RES via HTTP.
URL	getResURL() Returns the URL of the RES to be used for RuleApp deployment.
String	getResUser() Returns the username for connecting to RES via HTTP.
String	getTaskName() Returns the task name.
IlrTraceFilter	getTraceFilter() Returns the trace filter.
Serializable	getUserData() Returns the user data to be used for ruleset execution.
boolean	isKPIEnabled() Checks whether KPIs are enabled.
boolean	isTestEnabled() Checks whether tests are enabled.
Map<String,Serializable>	list() Returns all resources in a map.
void	setKPIEnabled(boolean enabled) Sets the KPI enabled flag.
void	setLocale(Locale locale) Sets the locale.
void	setProductionRulesetArchive(IlrRulesetArchive productionRulesetArchive) Sets the production (tested) ruleset archive, in case it must be deployed by the SSP before running tests.
void	setProductionRulesetProperties(Map<String,String> rulesetProperties) Sets the production (tested) ruleset properties.
void	setResPassword(String resPassword) Sets the password used to connect to RES via HTTP.
void	setResURL(URL resURL) Sets the URL of the RES to be used for RuleApp deployment.
void	setResUser(String resUser) Sets the username for connecting to RES via HTTP.
void	setTaskName(String taskName) Sets the task name.
void	setTestEnabled(boolean enabled) Sets whether tests are enabled.
void	setTraceFilter(IlrTraceFilter theTraceFilter) Sets the trace filter.
void	setUserData(Serializable userData) Sets the user data to be used for ruleset execution.

Method Detail

get

Serializable get(String identifier)

Returns the resource for an identifier.

Parameters:

identifier - The identifier to find a resource for.

Returns:

The resource that matches identifier. If no resource is found, null is returned.

list

Map<String,Serializable> list()

Returns all resources in a map.

Returns:

All resources in a map.

getFormatDescriptor

IlrScenarioFormatDescriptor getFormatDescriptor()

Returns the format descriptor.

Returns:

The format descriptor.

add

void add(String name,
         Serializable value)

Adds a resource with a given name.

Parameters:

name - The resource name.

value - The resource value.

getTaskName

String getTaskName()

Returns the task name. If set, the ruleset to be tested is executed from this task.

Returns:

The task name.

setTaskName

void setTaskName(String taskName)

Sets the task name. If set, the ruleset to be tested is executed from this task.

Parameters:

taskName - The task name.

getUserData

Serializable getUserData()

Returns the user data to be used for ruleset execution.

Returns:

The user data to be used for ruleset execution.

setUserData

void setUserData(Serializable userData)

Sets the user data to be used for ruleset execution.

Parameters:

userData - The user data to be used for ruleset execution.

getLocale

Locale getLocale()

Returns the locale.

Returns:

The locale.

setLocale

void setLocale(Locale locale)

Sets the locale.

Parameters:

locale - The locale.

getTraceFilter

IlrTraceFilter getTraceFilter()

Returns the trace filter.

Returns:

The trace filter.

setTraceFilter

void setTraceFilter(IlrTraceFilter theTraceFilter)

Sets the trace filter.

Parameters:

theTraceFilter - The trace filter.

getProductionRulesetArchive

IlrRulesetArchive getProductionRulesetArchive()

Returns the production (tested) ruleset archive.

Returns:

The production (tested) ruleset archive.

setProductionRulesetArchive

void setProductionRulesetArchive(IlrRulesetArchive productionRulesetArchive)

Sets the production (tested) ruleset archive, in case it must be deployed by the SSP before running tests.

Parameters:

productionRulesetArchive - The production (tested) ruleset archive, or null if the production ruleset archive has already been deployed.

setProductionRulesetProperties

void setProductionRulesetProperties(Map<String,String> rulesetProperties)

Sets the production (tested) ruleset properties.

Parameters:

rulesetProperties - The production (tested) ruleset properties.

getProductionRulesetProperties

Map<String,String> getProductionRulesetProperties()

Returns the production (tested) ruleset properties.

Returns:

The production (tested) ruleset properties.

setTestEnabled

void setTestEnabled(boolean enabled)

Sets whether tests are enabled. Use this flag to enable or disable tests in the scenario suite.

Parameters:

enabled - The test enabled flag.

isTestEnabled

boolean isTestEnabled()

Checks whether tests are enabled.

Returns:

true if tests are enabled.

setKPIEnabled

void setKPIEnabled(boolean enabled)

Sets the KPI enabled flag. Use this flag to enable or disable KPIs in the scenario suite.

Parameters:

enabled - The KPI enabled flag.

isKPIEnabled

boolean isKPIEnabled()

Checks whether KPIs are enabled.

Returns:

true if KPIs are enabled.

getResURL

URL getResURL()

Returns the URL of the RES to be used for RuleApp deployment. A possible URL is http://localhost:9080/res. If the URL is not set, RuleApp deployment is done using JMX instead of HTTP.

Returns:

The URL of the RES to be used for RuleApp deployment.

setResURL

void setResURL(URL resURL)

Sets the URL of the RES to be used for RuleApp deployment. A possible URL is http://localhost:9080/res. If the URL is not set, RuleApp deployment is done using JMX instead of HTTP.

Parameters:

resURL - The URL of the RES to be used for RuleApp deployment.

getResUser

String getResUser()

Returns the username for connecting to RES via HTTP. This is used only if the URL to RES is specified.

Returns:

The username for connecting to RES via HTTP.

setResUser

void setResUser(String resUser)

Sets the username for connecting to RES via HTTP. This is used only if the URL to RES is specified.

Parameters:

resUser - The username for connecting to RES via HTTP.

getResPassword

String getResPassword()

Returns the password used to connect to RES via HTTP. This password is used only if the URL to RES is specified.

Returns:

The password used to connect to RES via HTTP.

setResPassword

void setResPassword(String resPassword)

Sets the password used to connect to RES via HTTP. This password is used only if the URL to RES is specified.

Parameters:

resPassword - The password used to connect to RES via HTTP.