|
Rule Execution Server API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IlrJMXRuleAppMBean
IlrJMXRuleAppMBean
represents a RuleApp entity in the Rule
Execution Server management model.
Use the RuleApp entity to create, list, and remove rulesets, as well
as manage properties. It can also be used to create RuleApp
archives.
A JMX notification is sent if a property is changed on an MBean instance (on
the call of the method setProperty
). The notification type is
IlrJMXRuleAppMBean.NOTIFICATION_PROPERTY_CHANGE
. The message
contains the property key that has been changed. The new value of the
property is retrieved from userData
(null
if
the property has been removed).
For example to retrieve a deployed RuleApp:
public IlrJMXRuleAppMBean getRuleAppMBean(ObjectName ruleappMBeanName) { return (IlrJMXRuleAppMBean) Proxy.newProxyInstance(IlrJMXRuleAppMBean.class.getClassLoader(), new Class[] { IlrJMXRuleAppMBean.class }, createHandler(ruleappMBeanName)); }
IlrJMXRulesetMBean
,
IlrJMXRepositoryMBean
Field Summary | |
---|---|
static String |
KEY_NAME
The property key for the RuleApp name in the objectName of all RuleApp MBeans. |
static String |
KEY_VERSION
The property key for the RuleApp version in the objectName of all RuleApp MBeans. |
static String |
NOTIFICATION_PROPERTY_CHANGE
Notification type if a property is changed. |
static String |
VALUE_TYPE
The type used in the objectName of all RuleApp MBeans. |
Method Summary | |
---|---|
ObjectName |
addRuleset(String rulesetName,
String rulesetVersion,
byte[] rulesetArchive)
Adds the specific version of a ruleset . |
ObjectName |
addRuleset(String rulesetName,
String rulesetVersion,
String engineType,
byte[] rulesetArchive)
Adds the specific version of a ruleset. |
byte[] |
export()
Creates a RuleApp archive. |
ObjectName |
getGreatestRulesetObjectName(String rulesetName)
Returns the greatest version of a specific ruleset. |
Properties |
getProperties()
Returns all properties defined on this RuleApp. |
String |
getProperty(String key)
Returns the property value specified by the key. |
ObjectName |
getRulesetObjectName(String rulesetName,
String rulesetVersion)
Returns a specific ruleset version. |
Set<ObjectName> |
getRulesetObjectNames()
Returns all rulesets in the RuleApp. |
Set<ObjectName> |
getRulesetObjectNames(String rulesetName)
Returns all rulesets with a specific name. |
boolean |
removeRuleset(String rulesetName,
String rulesetVersion)
Removes a the specific version of a ruleset. |
void |
setProperty(String key,
String value)
Sets the value corresponding to a key. |
Methods inherited from interface ilog.rules.res.model.mbean.IlrJMXEntityMBean |
---|
getCreationDate, getDescription, getDisplayName, getModelObjectName, getName, getRepositoryObjectName, getVersion, setDescription, setDisplayName |
Field Detail |
---|
static final String VALUE_TYPE
static final String KEY_NAME
static final String KEY_VERSION
static final String NOTIFICATION_PROPERTY_CHANGE
Method Detail |
---|
Set<ObjectName> getRulesetObjectNames()
ObjectName
instances.Set<ObjectName> getRulesetObjectNames(String rulesetName)
rulesetName
- The name of the ruleset.
ObjectName
instances.ObjectName getGreatestRulesetObjectName(String rulesetName)
rulesetName
- The ruleset name.
rulesetName
does not exist,
null
is returned.ObjectName getRulesetObjectName(String rulesetName, String rulesetVersion)
rulesetName
- The ruleset name.rulesetVersion
- The ruleset version.
null
is returned.ObjectName addRuleset(String rulesetName, String rulesetVersion, String engineType, byte[] rulesetArchive) throws InstanceAlreadyExistsException, InvalidAttributeValueException, OperationsException
InstanceAlreadyExistsException
- if this ruleset already exists.
InvalidAttributeValueException
- if the parameters are invalid.
OperationsException
- If an internal error occurred.rulesetName
- The name of the ruleset. Must match the following regular expression
[\p{Alpha}\p{Digit}_]+
.
(rulesetVersion
- The version in the format: "MajorNumber.MinorNumber". MajorNumber must be greater than 0. MinorNumber
must be greater or equal to 0.engineType
- The engine type, either the classic rule
engine or the decision engine. To get the values,
call the IlrEngineType.toString()
method.rulesetArchive
- The ruleset archive to add. This parameter cannot be null
.
ObjectName addRuleset(String rulesetName, String rulesetVersion, byte[] rulesetArchive) throws InstanceAlreadyExistsException, InvalidAttributeValueException, OperationsException
InstanceAlreadyExistsException
- if this ruleset already exists.
InvalidAttributeValueException
- if the parameters are invalid.
OperationsException
- If an internal error occurred.rulesetName
- The name of the ruleset. Must match the following regular
expression [\p{Alpha}\p{Digit}_]+
.rulesetVersion
- The version in the format: "MajorNumber.MinorNumber".
MajorNumber must be greater than 0. MinorNumber must be
greater or equal to 0.rulesetArchive
- The ruleset archive to add. This parameter cannot be
null
.
boolean removeRuleset(String rulesetName, String rulesetVersion) throws OperationsException
OperationsException
- if an internal error occurred.rulesetName
- The ruleset name.rulesetVersion
- The version.
rulesetVersion
of
rulesetName
has been removed, true
is returned.
If this ruleset does not exist, false
is returned.String getProperty(String key) throws OperationsException
OperationsException
- if a data access error occurred.key
- The property key.
Properties getProperties() throws OperationsException
OperationsException
- if a data access error occurred.
void setProperty(String key, String value) throws OperationsException
OperationsException
- if a data access error occurred.key
- The key to be placed into the property list.value
- The value corresponding to key
.byte[] export() throws OperationsException
IOException
- if an IOException
occurs during RuleApp
archive creation.
OperationsException
- if an internal error occurs.
|
Rule Execution Server API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |