IlrRulesetArchiveProperties (Rule Execution Server API)

All Superinterfaces:

java.util.Map<java.lang.String,java.lang.String>
```
public interface IlrRulesetArchiveProperties
extends java.util.Map<java.lang.String,java.lang.String>
```
The IlrRulesetArchiveProperties interface represents a read-only container for IlrRulesetArchiveInformation properties.

Since:

7.0

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`DE_RULESET_READONLY_PROPERTIES` for DE Ruleset, below value of property is read only
`static java.lang.String`	`DEFAULT_VALUE_BOM_SUPPORT_ENABLED` The default value associated with `KEY_BOM_SUPPORT_ENABLED`.
`static java.lang.String`	`DEFAULT_VALUE_DEBUG_ENABLED` The default value associated with `KEY_DEBUG_ENABLED`.
`static java.lang.String`	`DEFAULT_VALUE_ENGINE_TYPE` The default engine type for this ruleset .
`static long`	`DEFAULT_VALUE_MAX_IDLE_TIME` The default value associated with `KEY_MAX_IDLE_TIME`.
`static java.lang.String`	`DEFAULT_VALUE_OPTIMIZATION_ENABLED` The default value associated with `KEY_OPTIMIZATION_ENABLED`.
`static java.lang.String`	`DEFAULT_VALUE_SEQUENTIAL_TRACE_ENABLED` The default value associated with `KEY_SEQUENTIAL_TRACE_ENABLED`.
`static java.lang.String`	`DEFAULT_VALUE_SEQUENTIAL_TRACED_TASKS` The default value associated with `KEY_SEQUENTIAL_TRACED_TASKS`.
`static java.lang.String`	`DEFAULT_VALUE_SHAREABLE` The default value associated with `KEY_SHAREABLE`.
`static java.lang.String`	`DEFAULT_VALUE_STATUS` The default value associated with `KEY_STATUS`.
`static java.lang.String`	`DEFAULT_VALUE_TRACE_ENABLED` The default value associated with `KEY_TRACE_ENABLED`.
`static java.lang.String`	`DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE` The default value associated with `KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE`.
`static java.lang.String`	`DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT` The default value associated with `KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT`.
`static java.lang.String`	`KEY_BASELINE_PROPERTY` The property key of Decision Center rule information
`static java.lang.String`	`KEY_BOM_SUPPORT_ENABLED` The `BOM_SUPPORT_ENABLED` property key.
`static java.lang.String`	`KEY_DEBUG_ENABLED` The `DEBUG_ENABLED` property key.
`static java.lang.String`	`KEY_ENGINE_TYPE` The `ENGINE_TYPE` property key.
`static java.lang.String`	`KEY_MANAGED_XOM_URIS` The `XOM_URIS` property key
`static java.lang.String`	`KEY_MAX_IDLE_TIME` The `MAX_IDLE_TIME` property key.
`static java.lang.String`	`KEY_MONITORING_BAM_BOM_FILTERS_PROP_NAME` The trace log on the property key of input and output parameters .
`static java.lang.String`	`KEY_MONITORING_BAM_FILTERS_PROP_NAME` The BAM filters on traces property key.
`static java.lang.String`	`KEY_MONITORING_ENABLED` The `MONITORING_ENABLED` property key.
`static java.lang.String`	`KEY_OPTIMIZATION_ENABLED` The `OPTIMIZATION_ENABLED` property key.
`static java.lang.String`	`KEY_PROJECT_PERMALINK_PROPERTY` The property key of the rule project permalink.
`static java.lang.String`	`KEY_REPORT_PERMALINK_PROPERTY` The property key of the rules permalink report.
`static java.lang.String`	`KEY_SEQUENTIAL_TRACE_ENABLED` The `SEQUENTIAL_TRACE_ENABLED` property key.
`static java.lang.String`	`KEY_SEQUENTIAL_TRACED_TASKS` The `SEQUENTIAL_TRACED_TASKS` property key.
`static java.lang.String`	`KEY_SHAREABLE` The `SHAREABLE` property key.
`static java.lang.String`	`KEY_STATUS` The `STATUS` property key.
`static java.lang.String`	`KEY_TRACE_ENABLED` The `TRACE_ENABLED` property key.
`static java.lang.String`	`KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE` The `XML_DOCUMENT_DRIVER_POOL_MAX_SIZE` property key.
`static java.lang.String`	`KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT` The `XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT` property key.
`static java.lang.String[]`	`KEYS` Contains the specific property keys.
`static long`	`VALUE_MAX_IDLE_TIME_INFINITE` The infinite maximum idle time value for `KEY_MAX_IDLE_TIME`.
`static long`	`VALUE_MAX_IDLE_TIME_UNSPECIFIED` The unspecified time value for `KEY_MAX_IDLE_TIME`.
`static java.lang.String`	`VALUE_STATUS_DISABLED` The value of the `STATUS` property when the ruleset is disabled.
`static java.lang.String`	`VALUE_STATUS_ENABLED` The value of the `STATUS` property when the ruleset is enabled.

Method Summary

Methods
Modifier and Type	Method and Description
`IlrEngineType`	`getEngineType()` Retrieves the engine type.
`java.lang.String[]`	`getManagedXOMURIs()` Retrieves the list of URIs of XOM JARs that are available in the repository.
`long`	`getMaxIdleTime()` Retrieves the maximum time in `ms` during which a ruleset is guaranteed to be kept in XU memory while idle.
`java.lang.String[]`	`getSequentialTracedTasks()` Retrieves the list of tasks for which the sequential mode traces are enabled.
`java.lang.String`	`getStatus()` Retrieves the ruleset status.
`int`	`getXMLDocumentDriverPoolMaxSize()` Retrieves the maximum size of the `IlrXmlDocumentDriver` pool.
`long`	`getXMLDocumentDriverPoolReserveTimeout()` Retrieves the number of milliseconds after which the calls to reserve an `IlrXmlDocumentDriver` object time out.
`boolean`	`isBOMSupportEnabled()` Checks whether BOM support is enabled.
`boolean`	`isDebugEnabled()` Checks whether debug mode is enabled.
`boolean`	`isMonitoringEnabled()` Checks whether ruleset monitoring is enabled.
`boolean`	`isOptimizationEnabled()` Checks whether ruleset optimization is enabled.
`boolean`	`isSequentialTraceEnabled()` Checks whether traces are enabled in the sequential execution mode.
`boolean`	`isShareable()` Checks whether instances of the given rulesets are reused and shared.
`boolean`	`isTraceEnabled()` Checks whether the rule engine traces are enabled.

Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

- Field Detail
  - VALUE_MAX_IDLE_TIME_INFINITE
```
static final long VALUE_MAX_IDLE_TIME_INFINITE
```
    The infinite maximum idle time value for KEY_MAX_IDLE_TIME.
    
    Since:
    
    7.1
    
    See Also:
    Constant Field Values
  - VALUE_MAX_IDLE_TIME_UNSPECIFIED
```
static final long VALUE_MAX_IDLE_TIME_UNSPECIFIED
```
    The unspecified time value for KEY_MAX_IDLE_TIME.
    
    Since:
    
    7.1
    
    See Also:
    Constant Field Values
  - KEY_MAX_IDLE_TIME
```
static final java.lang.String KEY_MAX_IDLE_TIME
```
    The MAX_IDLE_TIME property key.
    The maximum time in ms that a ruleset is guaranteed to be kept in XU memory while idle.
    
    Set to 0 value for infinite time, -1 if the time is not specified.
    
    Since:
    
    7.1
    
    See Also:
    Constant Field Values
  - KEY_DEBUG_ENABLED
```
static final java.lang.String KEY_DEBUG_ENABLED
```
    The DEBUG_ENABLED property key.
    
    See Also:
    Constant Field Values
  - KEY_SHAREABLE
```
static final java.lang.String KEY_SHAREABLE
```
    The SHAREABLE property key.
    
    See Also:
    Constant Field Values
  - KEY_TRACE_ENABLED
```
static final java.lang.String KEY_TRACE_ENABLED
```
    The TRACE_ENABLED property key.
    
    See Also:
    Constant Field Values
  - KEY_SEQUENTIAL_TRACE_ENABLED
```
static final java.lang.String KEY_SEQUENTIAL_TRACE_ENABLED
```
    The SEQUENTIAL_TRACE_ENABLED property key.
    
    See Also:
    Constant Field Values
  - KEY_SEQUENTIAL_TRACED_TASKS
```
static final java.lang.String KEY_SEQUENTIAL_TRACED_TASKS
```
    The SEQUENTIAL_TRACED_TASKS property key.
    
    See Also:
    Constant Field Values
  - KEY_STATUS
```
static final java.lang.String KEY_STATUS
```
    The STATUS property key.
    
    See Also:
    Constant Field Values
  - KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE
```
static final java.lang.String KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE
```
    The XML_DOCUMENT_DRIVER_POOL_MAX_SIZE property key.
    
    See Also:
    Constant Field Values
  - KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT
```
static final java.lang.String KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT
```
    The XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT property key.
    
    See Also:
    Constant Field Values
  - KEY_ENGINE_TYPE
```
static final java.lang.String KEY_ENGINE_TYPE
```
    The ENGINE_TYPE property key.
    
    Since:
    
    8.0.1
    
    See Also:
    IlrEngineType.CRE, IlrEngineType.DE, Constant Field Values
  - KEY_OPTIMIZATION_ENABLED
```
static final java.lang.String KEY_OPTIMIZATION_ENABLED
```
    The OPTIMIZATION_ENABLED property key.
    
    See Also:
    Constant Field Values
  - KEY_BOM_SUPPORT_ENABLED
```
static final java.lang.String KEY_BOM_SUPPORT_ENABLED
```
    The BOM_SUPPORT_ENABLED property key.
    
    See Also:
    Constant Field Values
  - KEY_MANAGED_XOM_URIS
```
static final java.lang.String KEY_MANAGED_XOM_URIS
```
    The XOM_URIS property key
    
    Since:
    
    7.5
    
    See Also:
    Constant Field Values
  - KEY_MONITORING_ENABLED
```
static final java.lang.String KEY_MONITORING_ENABLED
```
    The MONITORING_ENABLED property key.
    
    See Also:
    Constant Field Values
  - KEY_MONITORING_BAM_FILTERS_PROP_NAME
```
static final java.lang.String KEY_MONITORING_BAM_FILTERS_PROP_NAME
```
    The BAM filters on traces property key.
    
    See Also:
    Constant Field Values
  - KEY_MONITORING_BAM_BOM_FILTERS_PROP_NAME
```
static final java.lang.String KEY_MONITORING_BAM_BOM_FILTERS_PROP_NAME
```
    The trace log on the property key of input and output parameters .
    
    See Also:
    Constant Field Values
  - KEY_BASELINE_PROPERTY
```
static final java.lang.String KEY_BASELINE_PROPERTY
```
    The property key of Decision Center rule information
    
    See Also:
    Constant Field Values
  - KEY_PROJECT_PERMALINK_PROPERTY
```
static final java.lang.String KEY_PROJECT_PERMALINK_PROPERTY
```
    The property key of the rule project permalink.
    
    See Also:
    Constant Field Values
  - KEY_REPORT_PERMALINK_PROPERTY
```
static final java.lang.String KEY_REPORT_PERMALINK_PROPERTY
```
    The property key of the rules permalink report.
    
    See Also:
    Constant Field Values
  - KEYS
```
static final java.lang.String[] KEYS
```
    Contains the specific property keys. The Rule Execution Server console uses this table to present the end user a list of available properties for classic rule engine (CRE) rulesets when that user sets a new ruleset archive property.
  - VALUE_STATUS_ENABLED
```
static final java.lang.String VALUE_STATUS_ENABLED
```
    The value of the STATUS property when the ruleset is enabled.
    
    See Also:
    Constant Field Values
  - VALUE_STATUS_DISABLED
```
static final java.lang.String VALUE_STATUS_DISABLED
```
    The value of the STATUS property when the ruleset is disabled.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_MAX_IDLE_TIME
```
static final long DEFAULT_VALUE_MAX_IDLE_TIME
```
    The default value associated with KEY_MAX_IDLE_TIME.
    
    Since:
    
    7.1
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_DEBUG_ENABLED
```
static final java.lang.String DEFAULT_VALUE_DEBUG_ENABLED
```
    The default value associated with KEY_DEBUG_ENABLED.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_SHAREABLE
```
static final java.lang.String DEFAULT_VALUE_SHAREABLE
```
    The default value associated with KEY_SHAREABLE.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_TRACE_ENABLED
```
static final java.lang.String DEFAULT_VALUE_TRACE_ENABLED
```
    The default value associated with KEY_TRACE_ENABLED.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_SEQUENTIAL_TRACE_ENABLED
```
static final java.lang.String DEFAULT_VALUE_SEQUENTIAL_TRACE_ENABLED
```
    The default value associated with KEY_SEQUENTIAL_TRACE_ENABLED.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_SEQUENTIAL_TRACED_TASKS
```
static final java.lang.String DEFAULT_VALUE_SEQUENTIAL_TRACED_TASKS
```
    The default value associated with KEY_SEQUENTIAL_TRACED_TASKS.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_STATUS
```
static final java.lang.String DEFAULT_VALUE_STATUS
```
    The default value associated with KEY_STATUS.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE
```
static final java.lang.String DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE
```
    The default value associated with KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT
```
static final java.lang.String DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT
```
    The default value associated with KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_OPTIMIZATION_ENABLED
```
static final java.lang.String DEFAULT_VALUE_OPTIMIZATION_ENABLED
```
    The default value associated with KEY_OPTIMIZATION_ENABLED.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_BOM_SUPPORT_ENABLED
```
static final java.lang.String DEFAULT_VALUE_BOM_SUPPORT_ENABLED
```
    The default value associated with KEY_BOM_SUPPORT_ENABLED.
    The default value is true since version 8.0.1, and was false in earlier versions.
    
    See Also:
    Constant Field Values
  - DEFAULT_VALUE_ENGINE_TYPE
```
static final java.lang.String DEFAULT_VALUE_ENGINE_TYPE
```
    The default engine type for this ruleset .
    
    Since:
    
    8.0.1
  - DE_RULESET_READONLY_PROPERTIES
```
static final java.lang.String[] DE_RULESET_READONLY_PROPERTIES
```
    for DE Ruleset, below value of property is read only
- Method Detail
  - getXMLDocumentDriverPoolMaxSize
```
int getXMLDocumentDriverPoolMaxSize()
```
    Retrieves the maximum size of the IlrXmlDocumentDriver pool.
    
    Returns:
    The maximum size of the IlrXmlDocumentDriver pool.
    See Also:
    KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE, DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE
  - getXMLDocumentDriverPoolReserveTimeout
```
long getXMLDocumentDriverPoolReserveTimeout()
```
    Retrieves the number of milliseconds after which the calls to reserve an IlrXmlDocumentDriver object time out.
    
    Returns:
    The number of milliseconds after which the calls to reserve an IlrXmlDocumentDriver object time out.
    See Also:
    KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT, DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT
  - isBOMSupportEnabled
```
boolean isBOMSupportEnabled()
```
    Checks whether BOM support is enabled.
    
    Returns:
    true if BOM support is enabled.
  - isOptimizationEnabled
```
boolean isOptimizationEnabled()
```
    Checks whether ruleset optimization is enabled.
    
    Returns:
    true if optimization is enabled.
    See Also:
    KEY_OPTIMIZATION_ENABLED, DEFAULT_VALUE_OPTIMIZATION_ENABLED
  - isDebugEnabled
```
boolean isDebugEnabled()
```
    Checks whether debug mode is enabled.
    
    Returns:
    true if debug mode is enabled.
    See Also:
    KEY_DEBUG_ENABLED, DEFAULT_VALUE_DEBUG_ENABLED
  - isShareable
```
boolean isShareable()
```
    Checks whether instances of the given rulesets are reused and shared.
    
    Returns:
    true if the rulesets are shared.
    See Also:
    KEY_SHAREABLE, DEFAULT_VALUE_SHAREABLE
  - isTraceEnabled
```
boolean isTraceEnabled()
```
    Checks whether the rule engine traces are enabled.
    
    Returns:
    true if the rule engine traces are enabled.
    See Also:
    KEY_TRACE_ENABLED, DEFAULT_VALUE_TRACE_ENABLED
  - isMonitoringEnabled
```
boolean isMonitoringEnabled()
```
    Checks whether ruleset monitoring is enabled.
    
    Returns:
    true if ruleset monitoring is enabled.
    See Also:
    KEY_MONITORING_ENABLED
  - isSequentialTraceEnabled
```
boolean isSequentialTraceEnabled()
```
    Checks whether traces are enabled in the sequential execution mode.
    
    Returns:
    true if the traces are enabled.
    See Also:
    KEY_SEQUENTIAL_TRACE_ENABLED, DEFAULT_VALUE_SEQUENTIAL_TRACE_ENABLED
  - getSequentialTracedTasks
```
java.lang.String[] getSequentialTracedTasks()
```
    Retrieves the list of tasks for which the sequential mode traces are enabled.
    
    Returns:
    A list of tasks.
    See Also:
    KEY_SEQUENTIAL_TRACED_TASKS, DEFAULT_VALUE_SEQUENTIAL_TRACED_TASKS
  - getManagedXOMURIs
```
java.lang.String[] getManagedXOMURIs()
```
    Retrieves the list of URIs of XOM JARs that are available in the repository.
    
    Since:
    
    7.5
    
    Returns:
    A list of URIs.
  - getStatus
```
java.lang.String getStatus()
```
    Retrieves the ruleset status.
    
    Returns:
    A string representation of the status.
    See Also:
    KEY_STATUS, DEFAULT_VALUE_STATUS, VALUE_STATUS_DISABLED, VALUE_STATUS_ENABLED
  - getMaxIdleTime
```
long getMaxIdleTime()
```
    Retrieves the maximum time in ms during which a ruleset is guaranteed to be kept in XU memory while idle.
    
    Since:
    
    7.1
    
    Returns:
    The maximum time in ms during which a ruleset is guaranteed to be kept in XU memory while idle.
    See Also:
    DEFAULT_VALUE_MAX_IDLE_TIME, KEY_MAX_IDLE_TIME, VALUE_MAX_IDLE_TIME_INFINITE, VALUE_MAX_IDLE_TIME_UNSPECIFIED
  - getEngineType
```
IlrEngineType getEngineType()
```
    Retrieves the engine type.
    
    Since:
    
    8.0.1
    
    See Also:
    KEY_ENGINE_TYPE, IlrEngineType.DE, IlrEngineType.CRE

Nested classes/interfaces inherited from interface java.util.Map

Methods inherited from interface java.util.Map

VALUE_MAX_IDLE_TIME_INFINITE

VALUE_MAX_IDLE_TIME_UNSPECIFIED

KEY_MAX_IDLE_TIME

KEY_DEBUG_ENABLED

KEY_SHAREABLE

KEY_TRACE_ENABLED

KEY_SEQUENTIAL_TRACE_ENABLED

KEY_SEQUENTIAL_TRACED_TASKS

KEY_STATUS

KEY_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE

KEY_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT

KEY_ENGINE_TYPE

KEY_OPTIMIZATION_ENABLED

KEY_BOM_SUPPORT_ENABLED

KEY_MANAGED_XOM_URIS

KEY_MONITORING_ENABLED

KEY_MONITORING_BAM_FILTERS_PROP_NAME

KEY_MONITORING_BAM_BOM_FILTERS_PROP_NAME

KEY_BASELINE_PROPERTY

KEY_PROJECT_PERMALINK_PROPERTY

KEY_REPORT_PERMALINK_PROPERTY

KEYS

VALUE_STATUS_ENABLED

VALUE_STATUS_DISABLED

DEFAULT_VALUE_MAX_IDLE_TIME

DEFAULT_VALUE_DEBUG_ENABLED

DEFAULT_VALUE_SHAREABLE

DEFAULT_VALUE_TRACE_ENABLED

DEFAULT_VALUE_SEQUENTIAL_TRACE_ENABLED

DEFAULT_VALUE_SEQUENTIAL_TRACED_TASKS

DEFAULT_VALUE_STATUS

DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_MAX_SIZE

DEFAULT_VALUE_XML_DOCUMENT_DRIVER_POOL_RESERVE_TIMEOUT

DEFAULT_VALUE_OPTIMIZATION_ENABLED

DEFAULT_VALUE_BOM_SUPPORT_ENABLED

DEFAULT_VALUE_ENGINE_TYPE

DE_RULESET_READONLY_PROPERTIES

getXMLDocumentDriverPoolMaxSize

getXMLDocumentDriverPoolReserveTimeout

isBOMSupportEnabled

isOptimizationEnabled

isDebugEnabled

isShareable

isTraceEnabled

isMonitoringEnabled

isSequentialTraceEnabled

getSequentialTracedTasks

getManagedXOMURIs

getStatus

getMaxIdleTime

getEngineType