ilog.rules.res.model.mbean

Interface IlrJMXRepositoryMBean


  • public interface IlrJMXRepositoryMBean
    Represents the entry point for the Rule Execution Server management model.

    The Rule Execution Server model allows you to create, list, and remove RuleApps. It also provides facilities for processing and retrieving RuleApp archives.

    See Also:
    IlrJMXRulesetMBean, IlrJMXRuleAppMBean

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String VALUE_TYPE
      The type used in the objectName of the model MBean.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      javax.management.ObjectName addRuleApp(java.lang.String ruleAppName, java.lang.String ruleAppVersion)
      Returns a RuleApp with the name and the version.
      long getErrorCount()
      Returns the number of errors that occurred in all Execution Units (XU).
      javax.management.ObjectName getGreatestRuleAppObjectName(java.lang.String ruleAppName)
      Returns the RuleApp with the name and the greatest version or null if none.
      javax.management.ObjectName getRuleAppObjectName(java.lang.String ruleAppName, java.lang.String ruleAppVersion)
      Returns a RuleApp with the name and the version or null if none.
      java.util.Set<javax.management.ObjectName> getRuleAppObjectNames()
      Returns all RuleApps.
      java.util.Set<javax.management.ObjectName> getRuleAppObjectNames(java.lang.String ruleAppName)
      Returns all RuleApps with the specified name.
      long getWarningCount()
      Returns the number of warnings that occurred in all Execution Units (XU).
      java.util.Set importRuleApps(byte[] ruleAppArchive, java.lang.String mergingPolicy, java.lang.String versioningPolicy)
      Loads a RuleApp archive in the current model.
      boolean removeRuleApp(java.lang.String ruleAppName, java.lang.String ruleAppVersion)
      Removes a RuleApp with the name and the version.
      void resetErrorCount()
      Resets the error count for all XU MBeans.
      void resetWarningCount()
      Resets the warning count for all XU MBeans.

    • Field Detail

      • VALUE_TYPE

        static final java.lang.String VALUE_TYPE
        The type used in the objectName of the model MBean.
        See Also:
        Constant Field Values

    • Method Detail

      • getRuleAppObjectNames

        java.util.Set<javax.management.ObjectName> getRuleAppObjectNames()
        Returns all RuleApps.
        Returns:
        A set of ObjectNames.

      • getRuleAppObjectNames

        java.util.Set<javax.management.ObjectName> getRuleAppObjectNames(java.lang.String ruleAppName)
        Returns all RuleApps with the specified name.
        Parameters:
        ruleAppName - The name of the RuleApp.
        Returns:
        A set of ObjectNames.

      • getGreatestRuleAppObjectName

        javax.management.ObjectName getGreatestRuleAppObjectName(java.lang.String ruleAppName)
        Returns the RuleApp with the name and the greatest version or null if none.
        Since:
        6.0
        Parameters:
        ruleAppName - The name of the RuleApp.
        Returns:
        The RuleApp objectname or null.

      • getRuleAppObjectName

        javax.management.ObjectName getRuleAppObjectName(java.lang.String ruleAppName,
                                               java.lang.String ruleAppVersion)
        Returns a RuleApp with the name and the version or null if none.
        Parameters:
        ruleAppName - The name of the RuleApp.
        ruleAppVersion - The version with the format: "MajorNumber.MinorNumber".
        Returns:
        The RuleApp objectname or null.

      • addRuleApp

        javax.management.ObjectName addRuleApp(java.lang.String ruleAppName,
                                     java.lang.String ruleAppVersion)
                                       throws javax.management.InstanceAlreadyExistsException,
                                              javax.management.InvalidAttributeValueException,
                                              javax.management.OperationsException
        Returns a RuleApp with the name and the version.
        Throws:
        javax.management.InstanceAlreadyExistsException - If the specified RuleApp already exists.
        javax.management.InvalidAttributeValueException - If an attribute has the wrong format.
        javax.management.OperationsException - If an internal error occurred.
        Parameters:
        ruleAppName - The name of the RuleApp. Must match the regexp [\p{Alpha}\p{Digit}_]+
        ruleAppVersion - The version with the format: "MajorNumber.MinorNumber". MajorNumber must be greater than 0. MinorNumber must be greater or equal to 0.
        Returns:
        The RuleApp objectName.

      • removeRuleApp

        boolean removeRuleApp(java.lang.String ruleAppName,
                    java.lang.String ruleAppVersion)
                      throws javax.management.OperationsException
        Removes a RuleApp with the name and the version.

        If parameters do not match an existing RuleApp it returns false, otherwise it returns true.

        Throws:
        javax.management.OperationsException - If an internal error occurred.
        Parameters:
        ruleAppName - The name of the RuleApp.
        ruleAppVersion - The version of the RuleApp.
        Returns:
        true if the specified RuleApp has been removed, otherwise false.

      • importRuleApps

        java.util.Set importRuleApps(byte[] ruleAppArchive,
                           java.lang.String mergingPolicy,
                           java.lang.String versioningPolicy)
                             throws javax.management.InvalidAttributeValueException,
                                    java.io.IOException,
                                    javax.management.OperationsException
        Loads a RuleApp archive in the current model.

        Arguments mergingPolicy and versioningPolicy are used to resolve name and version conflicts between an existing RuleApp and a new RuleApp in an archive. Possible values are:

        • 'ADD_AT_END_MERGING_POLICY with MAJOR_VERSION_POLICY': The existing RuleApp is not modified. The version of the new RuleApp is modified to avoid a conflict. The new RuleApp version is the greater version for this RuleApp name with the major number incremented by 1 and 0 for the minor number. For example, if the RuleApp /MyRuleApp/1.0 already exists and you try to import a RuleApp archive that contains the RuleApp /MyRuleApp/1.0 then the existing RuleApp is not modified and the new RuleApp is added with the version 2.0.
        • 'ADD_AT_END_MERGING_POLICY with MINOR_VERSION_POLICY': The existing RuleApp is not modified. The version of the new RuleApp is modified to avoid a conflict. The new RuleApp version is the greater version for this RuleApp name with the minor number incremented by 1. For example, if the RuleApp /MyRuleApp/1.0 already exists and you try to import a RuleApp archive that contains the RuleApp /MyRuleApp/1.0 then the existing RuleApp is not modified and the new RuleApp is added with the version 1.1.
        • 'REPLACE_MERGING_POLICY': The existing RuleApp is replaced by the new RuleApp. With this policy the argument versioningPolicy is not used.
        • 'ADD_AT_END_RULESET_MERGING_POLICY with MAJOR_VERSION_POLICY': The existing Ruleset is not modified. The version of the new Ruleset is modified to avoid a conflict. The new Ruleset version is the greater version for this Ruleset name with the major number incremented by 1 and 0 for the minor number. For example, if the Ruleset /MyRuleApp/1.0/MyRuleset/1.0 already exists and you try to import a RuleApp archive that contains the RuleApp /MyRuleApp/1.0/MyRuleset/1.0 then the existing Ruleset is not modified and the new Ruleset is added with the version 2.0.
        • 'ADD_AT_END_RULESET_MERGING_POLICY with MINOR_VERSION_POLICY': The existing Ruleset is not modified. The version of the new Ruleset is modified to avoid a conflict. The new Ruleset version is the greater version for this Ruleset name with the minor number incremented by 1. For example, if the Ruleset /MyRuleApp/1.0/MyRuleset/1.0 already exists and you try to import a RuleApp archive that contains the Ruleset /MyRuleApp/1.0/MyRuleset/1.0 then the existing Ruleset is not modified and the new Ruleset is added with the version 1.1.
        • 'REPLACE_RULESET_MERGING_POLICY': The existing Ruleset is replaced by the new Ruleset. With this policy the argument versioningPolicy is not used.
        Throws:
        javax.management.InvalidAttributeValueException - If an attribute is invalid.
        java.io.IOException
        javax.management.OperationsException - If the RuleApp archive has the wrong format or an internal error occurred.
        Parameters:
        ruleAppArchive - A byte array of a Rule Execution Server management model archive contents. Cannot be null.
        mergingPolicy - The merging policy.
        versioningPolicy - The versioning policy.
        Returns:
        A set of ObjectNames for RuleApps that have been added to the current model.

      • getWarningCount

        long getWarningCount()
        Returns the number of warnings that occurred in all Execution Units (XU). It is the sum of the warnings obtained from all the XU MBeans found.
        Returns:
        The number of warnings for all XUs.

      • getErrorCount

        long getErrorCount()
        Returns the number of errors that occurred in all Execution Units (XU). It is the sum of errors obtained from all the XU MBeans found.
        Returns:
        The number of errors for all XUs.

      • resetWarningCount

        void resetWarningCount()
        Resets the warning count for all XU MBeans.

      • resetErrorCount

        void resetErrorCount()
        Resets the error count for all XU MBeans.
Rule Execution Server API

© Copyright IBM Corp. 1987, 2020