sample/java.util.PropertyPermission.txt

   1 *java.util.PropertyPermission* *PropertyPermission* This class is for property p
   2
   3 public final class PropertyPermission
   4   extends    |java.security.BasicPermission|
   5
   6 |java.util.PropertyPermission_Description|
   7 |java.util.PropertyPermission_Fields|
   8 |java.util.PropertyPermission_Constructors|
   9 |java.util.PropertyPermission_Methods|
  10
  11 ================================================================================
  12
  13 *java.util.PropertyPermission_Constructors*
  14 |java.util.PropertyPermission(String,String)|Creates a new PropertyPermission o
  15
  16 *java.util.PropertyPermission_Methods*
  17 |java.util.PropertyPermission.equals(Object)|Checks two PropertyPermission obje
  18 |java.util.PropertyPermission.getActions()|Returns the "canonical string repres
  19 |java.util.PropertyPermission.hashCode()|Returns the hash code value for this o
  20 |java.util.PropertyPermission.implies(Permission)|Checks if this PropertyPermis
  21 |java.util.PropertyPermission.newPermissionCollection()|Returns a new Permissio
  22
  23 *java.util.PropertyPermission_Description*
  24
  25 This class is for property permissions.
  26
  27 The name is the name of the property ("java.home", "os.name", etc). The naming
  28 convention follows the hierarchical property naming convention. Also, an
  29 asterisk may appear at the end of the name, following a ".", or by itself, to
  30 signify a wildcard match. For example: "java.*" or "*" is valid, "*java" or
  31 "a*b" is not valid.
  32
  33 The actions to be granted are passed to the constructor in a string containing
  34 a list of zero or more comma-separated keywords. The possible keywords are
  35 "read" and "write". Their meaning is defined as follows:
  36
  37 read read permission. Allows System.getProperty to be called. write write
  38 permission. Allows System.setProperty to be called.
  39
  40 The actions string is converted to lowercase before processing.
  41
  42 Care should be taken before granting code permission to access certain system
  43 properties. For example, granting permission to access the "java.home" system
  44 property gives potentially malevolent code sensitive information about the
  45 system environment (the Java installation directory). Also, granting permission
  46 to access the "user.name" and "user.home" system properties gives potentially
  47 malevolent code sensitive information about the user environment (the user's
  48 account name and home directory).
  49
  50
  51 *java.util.PropertyPermission(String,String)*
  52
  53 public PropertyPermission(
  54   java.lang.String name,
  55   java.lang.String actions)
  56
  57 Creates a new PropertyPermission object with the specified name. The name is
  58 the name of the system property, and actions contains a comma-separated list of
  59 the desired actions granted on the property. Possible actions are "read" and
  60 "write".
  61
  62     name - the name of the PropertyPermission.
  63     actions - the actions string.
  64
  65 *java.util.PropertyPermission.equals(Object)*
  66
  67 public boolean equals(java.lang.Object obj)
  68
  69 Checks two PropertyPermission objects for equality. Checks that obj is a
  70 PropertyPermission, and has the same name and actions as this object.
  71
  72     obj - the object we are testing for equality with this object.
  73
  74     Returns: true if obj is a PropertyPermission, and has the same name and actions as this
  75              PropertyPermission object.
  76 *java.util.PropertyPermission.getActions()*
  77
  78 public |java.lang.String| getActions()
  79
  80 Returns the "canonical string representation" of the actions. That is, this
  81 method always returns present actions in the following order: read, write. For
  82 example, if this PropertyPermission object allows both write and read actions,
  83 a call to getActions will return the string "read,write".
  84
  85
  86     Returns: the canonical string representation of the actions.
  87 *java.util.PropertyPermission.hashCode()*
  88
  89 public int hashCode()
  90
  91 Returns the hash code value for this object. The hash code used is the hash
  92 code of this permissions name, that is, getName().hashCode(), where getName is
  93 from the Permission superclass.
  94
  95
  96     Returns: a hash code value for this object.
  97 *java.util.PropertyPermission.implies(Permission)*
  98
  99 public boolean implies(java.security.Permission p)
 100
 101 Checks if this PropertyPermission object "implies" the specified permission.
 102
 103 More specifically, this method returns true if:
 104
 105 p is an instanceof PropertyPermission, p's actions are a subset of this
 106 object's actions, and p's name is implied by this object's name. For example,
 107 "java.*" implies "java.home".
 108
 109     p - the permission to check against.
 110
 111     Returns: true if the specified permission is implied by this object, false if not.
 112 *java.util.PropertyPermission.newPermissionCollection()*
 113
 114 public |java.security.PermissionCollection| newPermissionCollection()
 115
 116 Returns a new PermissionCollection object for storing PropertyPermission
 117 objects.
 118
 119
 120     Returns: a new PermissionCollection object suitable for storing PropertyPermissions.
 121