com.ibm.ibmi.are.xml.rules.authority
Class DataAuthorityRule

java.lang.Object
  extended by com.ibm.are.xml.rules.Rule
      extended by com.ibm.ibmi.are.xml.rules.authority.AuthorityRule
          extended by com.ibm.ibmi.are.xml.rules.authority.DataAuthorityRule

public class DataAuthorityRule
extends AuthorityRule

Rule class that verifies a specified user's private data authorities to a file, directory, or Library object

Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
static java.lang.String MAP_ITEM_DATA_AUTH
          The private data authority for the user to the file, directory, or Library object
static java.lang.String MAP_ITEM_USER
          The user with private authority to the file, directory, or Library object
 
Fields inherited from class com.ibm.ibmi.are.xml.rules.authority.AuthorityRule
MAP_ITEM_FOLLOW_SYMLINK, 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
DataAuthorityRule(java.util.Map ruleInfo)
          The API constructor for this class.
DataAuthorityRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, java.lang.String theFile, java.lang.String user, java.lang.String dataAuthority, boolean followSymlink)
          This constructor is for internal class use only.
 
Method Summary
 java.lang.String getDataAuthority()
          Retrieves the expected data authority
 java.lang.String getUser()
          Retrieves the user whose private authority is being verified
 boolean run(com.ibm.are.plugin.Plugin plugin)
          Runs the rule, which performs the check/verification implemented by that rule.
 void setDataAuthority(java.lang.String dataAuthority)
          Sets the expected data authority
 void setUser(java.lang.String user)
          Sets the user whose private authority is being verified
 
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_USER

public static final java.lang.String MAP_ITEM_USER
The user with private authority to the file, directory, or Library object

See Also:
Constant Field Values

MAP_ITEM_DATA_AUTH

public static final java.lang.String MAP_ITEM_DATA_AUTH
The private data authority for the user to the file, directory, or Library object

See Also:
Constant Field Values
Constructor Detail

DataAuthorityRule

public DataAuthorityRule(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 directory, file, or Library object to verify Yes The path must be fully qualified. If the file to verify is in the Library file system, the path must be an IFS path, such as /QSYS.LIB/MYLIB.LIB/THEFILE.PGM N/A
user The user profile whose data authority to the file is to be verified Yes Must be a valid IBM i user profile N/A
dataAuth The expected data authority granted to the specified user profile Yes Verify exact authority
  • *R
  • *W
  • *X
  • *RX
  • *RW
  • *WX
  • *RWX
  • *EXCLUDE

Verify minimum authority

  • R
  • W
  • X
  • RX
  • RW
  • WX
N/A
followSymlink If the file or directory is a symbolic link, this item determines if the authority of the symbolic link is verified, or if the authority of the symbolic link target is verified. No
  • true
  • false
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
  • warning
  • info
error

DataAuthorityRule

public DataAuthorityRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
                         java.lang.String theFile,
                         java.lang.String user,
                         java.lang.String dataAuthority,
                         boolean followSymlink)
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

getDataAuthority

public java.lang.String getDataAuthority()
Retrieves the expected data authority

Returns:
The expected data authority

setDataAuthority

public void setDataAuthority(java.lang.String dataAuthority)
Sets the expected data authority

Parameters:
dataAuthority - The expected data authority

getUser

public java.lang.String getUser()
Retrieves the user whose private authority is being verified

Returns:
The user whose private authority is being verified

setUser

public void setUser(java.lang.String user)
Sets the user whose private authority is being verified

Parameters:
user - The user whose private authority is being verified

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.