com.ibm.ibmi.are.xml.rules.product
Class ProductStatusRule

java.lang.Object
  extended by com.ibm.are.xml.rules.Rule
      extended by com.ibm.ibmi.are.xml.rules.product.ProductRule
          extended by com.ibm.ibmi.are.xml.rules.product.ProductStatusRule

public class ProductStatusRule
extends ProductRule

Rule class that verifies the install status of an IBM i product

Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
static java.lang.String MAP_ITEM_STATUS
           
 
Fields inherited from class com.ibm.ibmi.are.xml.rules.product.ProductRule
MAP_ITEM_MOD_LEVEL_CHECK, MAP_ITEM_OPTION, MAP_ITEM_OS_VERSION, MAP_ITEM_PRODUCT_NAME
 
Fields inherited from class com.ibm.are.xml.rules.Rule
MAP_ITEM_CHECK_CLASS, MAP_ITEM_CHECK_OBJECT, MAP_ITEM_CHECK_TYPE, MAP_ITEM_ERROR_LEVEL, MAP_ITEM_EXPECTED_VALUE, MAP_ITEM_MATCH_CASE
 
Constructor Summary
ProductStatusRule(java.util.Map ruleInfo)
          The API constructor for this class.
ProductStatusRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, java.lang.String productName, java.lang.String productOption, java.lang.String osVersion, java.lang.String expectedStatus, java.lang.String modLevelCheck)
          This constructor is for internal class use only.
 
Method Summary
 boolean run(com.ibm.are.plugin.Plugin plugin)
          Runs the rule, which performs the check/verification implemented by that rule.
 
Methods inherited from class com.ibm.are.xml.rules.Rule
getNodeInfo, report, report
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values

MAP_ITEM_STATUS

public static final java.lang.String MAP_ITEM_STATUS
See Also:
Constant Field Values
Constructor Detail

ProductStatusRule

public ProductStatusRule(java.util.Map ruleInfo)
The API constructor for this class. This API can be used to leverage the capabilities of this rule class from within any Application Runtime Expert plugin.

Parameters:
ruleInfo - Any object that implements the java.util.Map interface. This map contains a set of key/value pairs which specify all of the information needed by this rule class to perform its check.

Rule Info Map Contents

The table below describes all items, both required and optional, that are allowed to be in the ruleInfo map passed to the API constructor.

Key Description Required Valid Values Default Value
name The name (product ID) of the IBM i product for which the install status will be verified. Yes Must be a valid IBM i product ID.

Examples:

  • 5770SS1
  • 5733ARE
N/A
option The product option of the IBM i product for which the install status will be verified. Yes
  • *BASE
  • A number between 1 and 99
N/A
osVersion The version, release, and modification (VRM) level of the IBM i product for which the install status will be verified. No Must be in the standard IBM i VxRxMx format Defaults to the VRM of the IBM i OS where the verification is being performed
status The expected install status for the specified IBM i product. Yes
  • installed
  • not installed
N/A
modLevelCheck Determines if the version, release, and modification (VRM) level of the IBM i product is strictly checked. For example, if the expected VRM was V7R1M0 and the actual VRM on the system being verified was V7R1M1, this would result in a problem being reported if strict level checking was enforced. No
  • strict
  • notStrict
strict except for the base IBM i OS product, 57nn999, where the default is notStrict
errorLevel Specifies the severity level a problem is reported at for this check. If the comparison between the expected and actual values is not successful, which means the comparison result was false, a problem is reported. The severity of the reported problem is determined by the error level. No
  • error
  • warning
  • info
error

ProductStatusRule

public ProductStatusRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
                         java.lang.String productName,
                         java.lang.String productOption,
                         java.lang.String osVersion,
                         java.lang.String expectedStatus,
                         java.lang.String modLevelCheck)
This constructor is for internal class use only. New instances of this class should only be created using the API constructor for this class.

Method Detail

run

public boolean run(com.ibm.are.plugin.Plugin plugin)
Runs the rule, which performs the check/verification implemented by that rule.

Specified by:
run in class Rule
Parameters:
plugin - The plugin for which the rule is being run for.
Returns:
true if the verification was successful and no problems were found. false if the verification resulted in a problem being found and reported.