JndiPermission

java.lang.Object
- java.security.Permission
- - org.jboss.naming.JndiPermission

All Implemented Interfaces:

java.io.Serializable, java.security.Guard
```
public final class JndiPermission
extends java.security.Permission
implements java.io.Serializable
```
This class represents access to a path in the JNDI tree. A JndiPermission consists of a pathname and a set of actions valid for that pathname.
Pathname is the pathname of the file or directory granted the specified actions. A pathname that ends in "/*" indicates all the files and directories contained in that directory. A pathname that ends with "/-" indicates (recursively) all files and subdirectories contained in that directory. A pathname consisting of the special token "<<ALL BINDINGS>>" matches any file.
The actions to be granted are passed to the constructor in a string containing a list of one or more comma-separated keywords. The possible keywords are "bind", "rebind", "unbind", "lookup", "list", "listBindings", and "createSubcontext". Their meaning is defined as follows:

bind
Context.bind permission
rebind
Context.rebind permission
unbind
Context.unbind permission.
lookup
Context.lookup permission.
list
Context.list permission.
listBindings
Context.listBindings permission.
createSubcontext
Context.createSubcontext permission.

The actions string is converted to lowercase before processing.
Be careful when granting JndiPermissions. Think about the implications of granting read and especially write access to various files and directories. The "<<ALL BINDINGS>>" permission with write action is especially dangerous. This grants permission to write to the entire file system. One thing this effectively allows is replacement of the system binary, including the JVM runtime environment.
Please note: Code can always read a file from the same directory it's in (or a subdirectory of that directory); it does not need explicit permission to do so.

Version:

$Revision: 81310 $

See Also:

Permission, Permissions, PermissionCollection

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`ACTION_COUNT`
`private static java.util.HashMap<java.lang.String,java.lang.Integer>`	`actionMap`
`private java.lang.String`	`actions` the actions string.
`static int`	`ALL` All actions (bind, rebind, unbind, lookup, list, listBindings, createSubcontext)
`static java.lang.String`	`ALL_ACTION`
`private static java.lang.String[]`	`ALL_ACTIONS`
`static int`	`BIND` bind action.
`static java.lang.String`	`BIND_ACTION`
`private java.lang.String`	`cpath`
`static int`	`CREATE_SUBCONTEXT`
`static java.lang.String`	`CREATE_SUBCONTEXT_ACTION`
`private boolean`	`directory`
`static int`	`LIST` list action.
`static java.lang.String`	`LIST_ACTION`
`static int`	`LIST_BINDINGS`
`static java.lang.String`	`LIST_BINDINGS_ACTION`
`static int`	`LOOKUP` lookup action.
`static java.lang.String`	`LOOKUP_ACTION`
`private int`	`mask`
`static int`	`NONE` No actions.
`static int`	`REBIND` rebind action.
`static java.lang.String`	`REBIND_ACTION`
`private boolean`	`recursive`
`private static char`	`RECURSIVE_CHAR`
`private static long`	`serialVersionUID`
`static int`	`UNBIND` unbind action.
`static java.lang.String`	`UNBIND_ACTION`
`private static char`	`WILD_CHAR`

Constructor Summary

Constructors
Constructor and Description
`JndiPermission(javax.naming.Name path, int mask)`
`JndiPermission(javax.naming.Name path, java.lang.String actions)`
`JndiPermission(java.lang.String path, int mask)` Creates a new JndiPermission object using an action mask.
`JndiPermission(java.lang.String path, java.lang.String actions)` Creates a new JndiPermission object with the specified actions.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Checks two JndiPermission objects for equality.
`java.lang.String`	`getActions()` Returns the "canonical string representation" of the actions.
`private static java.lang.String`	`getActions(int mask)` Return the canonical string representation of the actions.
`(package private) int`	`getMask()` Return the current action mask.
`private static int`	`getMask(java.lang.String actions)` Converts an actions String to an actions mask.
`int`	`hashCode()` Returns the hash code value for this object.
`boolean`	`implies(java.security.Permission p)` Checks if this JndiPermission object "implies" the specified permission.
`(package private) boolean`	`impliesIgnoreMask(JndiPermission that)` Checks if the Permission's actions are a proper subset of the this object's actions.
`private void`	`init(int mask)` initialize a JndiPermission object.
`java.security.PermissionCollection`	`newPermissionCollection()` Returns a new PermissionCollection object for storing JndiPermission objects.
`private void`	`readObject(java.io.ObjectInputStream s)` readObject is called to restore the state of the JndiPermission from a stream.
`private void`	`writeObject(java.io.ObjectOutputStream s)` WriteObject is called to save the state of the JndiPermission to a stream.

Methods inherited from class java.security.Permission
checkGuard, getName, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - BIND
```
public static final int BIND
```
    bind action.
    
    See Also:
    
    Constant Field Values
  - REBIND
```
public static final int REBIND
```
    rebind action.
    
    See Also:
    
    Constant Field Values
  - UNBIND
```
public static final int UNBIND
```
    unbind action.
    
    See Also:
    
    Constant Field Values
  - LOOKUP
```
public static final int LOOKUP
```
    lookup action.
    
    See Also:
    
    Constant Field Values
  - LIST
```
public static final int LIST
```
    list action.
    
    See Also:
    
    Constant Field Values
  - LIST_BINDINGS
```
public static final int LIST_BINDINGS
```
    See Also:
    
    Constant Field Values
  - CREATE_SUBCONTEXT
```
public static final int CREATE_SUBCONTEXT
```
    See Also:
    
    Constant Field Values
  - ACTION_COUNT
```
private static final int ACTION_COUNT
```
    See Also:
    
    Constant Field Values
  - ALL
```
public static final int ALL
```
    All actions (bind, rebind, unbind, lookup, list, listBindings, createSubcontext)
    
    See Also:
    
    Constant Field Values
  - NONE
```
public static final int NONE
```
    No actions.
    
    See Also:
    
    Constant Field Values
  - BIND_ACTION
```
public static final java.lang.String BIND_ACTION
```
    See Also:
    
    Constant Field Values
  - REBIND_ACTION
```
public static final java.lang.String REBIND_ACTION
```
    See Also:
    
    Constant Field Values
  - UNBIND_ACTION
```
public static final java.lang.String UNBIND_ACTION
```
    See Also:
    
    Constant Field Values
  - LOOKUP_ACTION
```
public static final java.lang.String LOOKUP_ACTION
```
    See Also:
    
    Constant Field Values
  - LIST_ACTION
```
public static final java.lang.String LIST_ACTION
```
    See Also:
    
    Constant Field Values
  - LIST_BINDINGS_ACTION
```
public static final java.lang.String LIST_BINDINGS_ACTION
```
    See Also:
    
    Constant Field Values
  - ALL_ACTION
```
public static final java.lang.String ALL_ACTION
```
    See Also:
    
    Constant Field Values
  - CREATE_SUBCONTEXT_ACTION
```
public static final java.lang.String CREATE_SUBCONTEXT_ACTION
```
    See Also:
    
    Constant Field Values
  - ALL_ACTIONS
```
private static final java.lang.String[] ALL_ACTIONS
```
  - actionMap
```
private static final java.util.HashMap<java.lang.String,java.lang.Integer> actionMap
```
  - mask
```
private transient int mask
```
  - directory
```
private transient boolean directory
```
  - recursive
```
private transient boolean recursive
```
  - actions
```
private java.lang.String actions
```
    the actions string.
  - cpath
```
private transient java.lang.String cpath
```
  - RECURSIVE_CHAR
```
private static final char RECURSIVE_CHAR
```
    See Also:
    
    Constant Field Values
  - WILD_CHAR
```
private static final char WILD_CHAR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JndiPermission
```
public JndiPermission(java.lang.String path,
                      java.lang.String actions)
```
    Creates a new JndiPermission object with the specified actions. path is the pathname of a file or directory, and actions contains a comma-separated list of the desired actions granted on the file or directory. Possible actions are "bind", "rebind", "unbind", "lookup", "list", "listBindings", and "createSubcontext".
    A pathname that ends in "/*" (where "/" is the file separator character, '/') indicates all the files and directories contained in that directory. A pathname that ends with "/-" indicates (recursively) all files and subdirectories contained in that directory. The special pathname "<<ALL BINDINGS>>" matches any file.
    A pathname consisting of a single "*" indicates all the files in the current directory, while a pathname consisting of a single "-" indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory.
    A pathname containing an empty string represents an empty path.
    
    Parameters:
    
    path - the pathname of the file/directory.
    
    actions - the action string.
    
    Throws:
    
    java.lang.IllegalArgumentException - If actions is null, empty or contains an action other than the specified possible actions.
  - JndiPermission
```
public JndiPermission(javax.naming.Name path,
                      java.lang.String actions)
```
  - JndiPermission
```
JndiPermission(java.lang.String path,
               int mask)
```
    Creates a new JndiPermission object using an action mask. More efficient than the JndiPermission(String, String) constructor. Can be used from within code that needs to create a JndiPermission object to pass into the implies method.
    
    Parameters:
    
    path - the pathname of the file/directory.
    
    mask - the action mask to use.
  - JndiPermission
```
public JndiPermission(javax.naming.Name path,
                      int mask)
```
- Method Detail
  - init
```
private void init(int mask)
```
    initialize a JndiPermission object. Common to all constructors. Also called during de-serialization.
    
    Parameters:
    
    mask - the actions mask to use.
  - implies
```
public boolean implies(java.security.Permission p)
```
    Checks if this JndiPermission object "implies" the specified permission.
    More specifically, this method returns true if:
    - p is an instanceof JndiPermission,
    - p's actions are a proper subset of this object's actions, and
    - p's pathname is implied by this object's pathname. For example, "/tmp/*" implies "/tmp/foo", since "/tmp/*" encompasses all files in the "/tmp" directory, including the one named "foo".
    Specified by:
    
    implies in class java.security.Permission
    
    Parameters:
    
    p - the permission to check against.
    
    Returns:
    
    true if the specified permission is not null and is implied by this object, false otherwise.
  - impliesIgnoreMask
```
boolean impliesIgnoreMask(JndiPermission that)
```
    Checks if the Permission's actions are a proper subset of the this object's actions. Returns the effective mask iff the this JndiPermission's path also implies that JndiPermission's path.
    
    Parameters:
    
    that - the JndiPermission to check against.
    
    exact - return immediately if the masks are not equal
    
    Returns:
    
    the effective mask
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks two JndiPermission objects for equality. Checks that obj is a JndiPermission, and has the same pathname and actions as this object.
    
    Specified by:
    
    equals in class java.security.Permission
    
    Parameters:
    
    obj - the object we are testing for equality with this object.
    
    Returns:
    
    true if obj is a JndiPermission, and has the same pathname and actions as this JndiPermission object, false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this object.
    
    Specified by:
    
    hashCode in class java.security.Permission
    
    Returns:
    
    a hash code value for this object.
  - getMask
```
private static int getMask(java.lang.String actions)
```
    Converts an actions String to an actions mask.
    
    Parameters:
    
    action - - the comma separated list of actions.
    
    Returns:
    
    the actions mask.
  - getMask
```
int getMask()
```
    Return the current action mask. Used by the JndiPermissionCollection.
    
    Returns:
    
    the actions mask.
  - getActions
```
private static java.lang.String getActions(int mask)
```
    Return the canonical string representation of the actions. Always returns present actions in the following order: bind, rebind, unbind, lookup, list, listBindings, createSubcontext
    
    Returns:
    
    the canonical string representation of the actions.
  - getActions
```
public java.lang.String getActions()
```
    Returns the "canonical string representation" of the actions. That is, this method always returns present actions in the following order: bind, rebind, unbind, lookup, list, listBindings, createSubcontext. For example, if this JndiPermission object allows both unbind and bind actions, a call to getActions will return the string "bind,unbind".
    
    Specified by:
    
    getActions in class java.security.Permission
    
    Returns:
    
    the canonical string representation of the actions.
  - newPermissionCollection
```
public java.security.PermissionCollection newPermissionCollection()
```
    Returns a new PermissionCollection object for storing JndiPermission objects.
    JndiPermission objects must be stored in a manner that allows them to be inserted into the collection in any order, but that also enables the PermissionCollection implies method to be implemented in an efficient (and consistent) manner.
    For example, if you have two JndiPermissions:
    1. "/tmp/-", "bind"
    2. "/tmp/scratch/foo", "unbind"
    and you are calling the implies method with the JndiPermission:
```
   "/tmp/scratch/foo", "bind,unbind",
 
```
    then the implies function must take into account both the "/tmp/-" and "/tmp/scratch/foo" permissions, so the effective permission is "bind,unbind", and implies returns true. The "implies" semantics for JndiPermissions are handled properly by the PermissionCollection object returned by this newPermissionCollection method.
    Overrides:
    
    newPermissionCollection in class java.security.Permission
    
    Returns:
    
    a new PermissionCollection object suitable for storing JndiPermissions.
  - writeObject
```
private void writeObject(java.io.ObjectOutputStream s)
                  throws java.io.IOException
```
    WriteObject is called to save the state of the JndiPermission to a stream. The actions are serialized, and the superclass takes care of the name.
    
    Throws:
    
    java.io.IOException
  - readObject
```
private void readObject(java.io.ObjectInputStream s)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
```
    readObject is called to restore the state of the JndiPermission from a stream.
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

Class JndiPermission

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.security.Permission

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

BIND

REBIND

UNBIND

LOOKUP

LIST

LIST_BINDINGS

CREATE_SUBCONTEXT

ACTION_COUNT

ALL

NONE

BIND_ACTION

REBIND_ACTION

UNBIND_ACTION

LOOKUP_ACTION

LIST_ACTION

LIST_BINDINGS_ACTION

ALL_ACTION

CREATE_SUBCONTEXT_ACTION

ALL_ACTIONS

actionMap

mask

directory

recursive

actions

cpath

RECURSIVE_CHAR

WILD_CHAR

Constructor Detail

JndiPermission

JndiPermission

JndiPermission

JndiPermission

Method Detail

init

implies

impliesIgnoreMask

equals

hashCode

getMask

getMask

getActions

getActions

newPermissionCollection

writeObject

readObject