|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.are.xml.rules.Rule
com.ibm.are.xml.rules.config.ConfigurationRule
public class ConfigurationRule
Rule class that verifies a key/value pair in a configuration file. The following types of configuration files are supported:
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
static java.lang.String |
MAP_ITEM_KEY
The configuration item key |
static java.lang.String |
MAP_ITEM_KEY_METADATA
Any additional information associated with the configuration item key |
static java.lang.String |
MAP_ITEM_NAME
The name of the configuration file |
static java.lang.String |
MAP_ITEM_TYPE
The type of configuration file |
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 | |
---|---|
ConfigurationRule(java.util.Map ruleInfo)
The API constructor for this class. |
|
ConfigurationRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
com.ibm.are.plugin.support.Descriptor key,
com.ibm.are.plugin.support.FileContents fileContents,
Check checkOperation)
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 |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String MAP_ITEM_KEY
public static final java.lang.String MAP_ITEM_KEY_METADATA
public static final java.lang.String MAP_ITEM_NAME
public static final java.lang.String MAP_ITEM_TYPE
Constructor Detail |
---|
public ConfigurationRule(java.util.Map ruleInfo)
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 |
---|---|---|---|---|
key | The key associated with the configuration value to check. | Yes | The only limitations on this value is that it cannot be null or an empty, zero length string. |
N/A |
keyMetaData | Additional information associated with the key item. | No | None | null |
name | The full path of the configuration file that contains the value to check. | Yes | Path must be fully qualified, and must be the path to a supported configuration file type. | N/A |
type | The configuration file type. | Yes |
|
null |
checkClass | The data type (class) of the expected and actual values. | No |
|
string |
checkType | The type of check to perform between the expected and actual values. Or said another way,
this value specifies how the expected and actual values are compared. The check type
is related to the check class, so care must be taken when specifying these two values.
For example, a check type of inRange is valid only if the check class is set to
numeric . |
No | For a list of all supported check types, see the com.ibm.are.xml.check.Check class documentation |
equals |
expectedValue | The expected value is the value that is used to compare against, or check, the actual value. | Yes | The only limitations on this value is that it cannot be null or an empty, zero length string. |
N/A |
matchCase | Specifies whether or not character case is honored when performing string comparisons.
This value is only applicable when the check class value is set to string , and is
ignored for any other check class. |
No |
A value of |
false |
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 |
public ConfigurationRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, com.ibm.are.plugin.support.Descriptor key, com.ibm.are.plugin.support.FileContents fileContents, Check checkOperation)
Method Detail |
---|
public boolean run(com.ibm.are.plugin.Plugin plugin)
run
in class Rule
plugin
- The plugin for which the rule is being run for.
true
if the verification was successful and no problems were found.
false
if the verification resulted in a problem being found and reported.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |