com.ibm.are.xml.rules.fileattr
Class FileTypeRule

java.lang.Object
  extended by com.ibm.are.xml.rules.Rule
      extended by com.ibm.are.xml.rules.fileattr.FileAttributeRule
          extended by com.ibm.are.xml.rules.fileattr.FileTypeRule

public class FileTypeRule
extends FileAttributeRule

Rule class that verifies the file type

Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Fields inherited from class com.ibm.are.xml.rules.fileattr.FileAttributeRule
MAP_ITEM_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
FileTypeRule(java.util.Map ruleInfo)
          The API constructor for this class.
FileTypeRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, java.lang.String theFile, com.ibm.are.platform.FileTypes expectedType)
          This constructor is for internal class use only.
 
Method Summary
 com.ibm.are.platform.FileTypes getExpectedType()
          Retrieves the expected file type
 boolean run(com.ibm.are.plugin.Plugin plugin)
          Runs the rule, which performs the check/verification implemented by that rule.
 void setExpectedType(com.ibm.are.platform.FileTypes expectedType)
          Sets the expected file type
 
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
Constructor Detail

FileTypeRule

public FileTypeRule(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 full path of the file to verify Yes Path must be fully qualified N/A
type The expected file type Yes Valid file types are platform specific, except for the following types which are supported on any platform.
  • FILE
  • DIR
  • SYMLNK
N/A
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

FileTypeRule

public FileTypeRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
                    java.lang.String theFile,
                    com.ibm.are.platform.FileTypes expectedType)
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

getExpectedType

public com.ibm.are.platform.FileTypes getExpectedType()
Retrieves the expected file type

Returns:
The expected file type

setExpectedType

public void setExpectedType(com.ibm.are.platform.FileTypes expectedType)
Sets the expected file type

Parameters:
expectedType - The expected file type

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.