javax.management: public class: MBeanServerPermission

javax.management
public class: MBeanServerPermission [javadoc | source]

java.lang.Object
   java.security.Permission
      java.security.BasicPermission
         javax.management.MBeanServerPermission

All Implemented Interfaces:
Serializable, Guard

A Permission to perform actions related to MBeanServers. The name of the permission specifies the operation requested or granted by the permission. For a granted permission, it can be * to allow all of the MBeanServer operations specified below. Otherwise, for a granted or requested permission, it must be one of the following:

createMBeanServer: Create a new MBeanServer object using the method MBeanServerFactory#createMBeanServer() or MBeanServerFactory#createMBeanServer(java.lang.String) .
findMBeanServer: Find an MBeanServer with a given name, or all MBeanServers in this JVM, using the method MBeanServerFactory#findMBeanServer .
newMBeanServer: Create a new MBeanServer object without keeping a reference to it, using the method MBeanServerFactory#newMBeanServer() or MBeanServerFactory#newMBeanServer(java.lang.String) .
releaseMBeanServer: Remove the MBeanServerFactory's reference to an MBeanServer, using the method MBeanServerFactory#releaseMBeanServer .

The name of the permission can also denote a list of one or more comma-separated operations. Spaces are allowed at the beginning and end of the name and before and after commas.

MBeanServerPermission("createMBeanServer") implies MBeanServerPermission("newMBeanServer").

since: 1.5 -

Field Summary
transient int	mask

Constructor:

Constructor:
public MBeanServerPermission(String name) { this(name, null); } Create a new MBeanServerPermission with the given name. This constructor is equivalent to `MBeanServerPermission(name,null)`. Parameters: `name` - the name of the granted permission. It must respect the constraints spelt out in the description of the MBeanServerPermission class. Throws: `NullPointerException` - if the name is null. `IllegalArgumentException` - if the name is not `` or one of the allowed names or a comma-separated list of the allowed names. exception: `NullPointerException` - if the name is null. exception: `IllegalArgumentException` - if the name is not `` or one of the allowed names or a comma-separated list of the allowed names.
MBeanServerPermission(int mask) { super(getCanonicalName(mask)); this.mask = impliedMask(mask); }
public MBeanServerPermission(String name, String actions) { super(getCanonicalName(parseMask(name)), actions); /* It's annoying to have to parse the name twice, but since Permission.getName() is final and since we can't access "this" until after the call to the superclass constructor, there isn't any very clean way to do this. MBeanServerPermission objects aren't constructed very often, luckily. / mask = parseMask(name); / Check that actions is a null empty string / if (actions != null && actions.length() > 0) throw new IllegalArgumentException("MBeanServerPermission " + "actions must be null: " + actions); } Create a new MBeanServerPermission with the given name. Parameters:* `name` - the name of the granted permission. It must respect the constraints spelt out in the description of the MBeanServerPermission class. `actions` - the associated actions. This parameter is not currently used and must be null or the empty string. Throws: `NullPointerException` - if the name is null. `IllegalArgumentException` - if the name is not `` or one of the allowed names or a comma-separated list of the allowed names, or if `actions` is a non-null non-empty string. `NullPointerException` - if `name` is `null`. `IllegalArgumentException` - if `name` is empty or if arguments are invalid. exception: `NullPointerException` - if the name is null. exception: `IllegalArgumentException` - if the name is not `` or one of the allowed names or a comma-separated list of the allowed names, or if `actions` is a non-null non-empty string.

 public MBeanServerPermission(String name) {
        this(name, null);
}

Create a new MBeanServerPermission with the given name.

This constructor is equivalent to MBeanServerPermission(name,null).

Parameters:

name - the name of the granted permission. It must respect the constraints spelt out in the description of the MBeanServerPermission class.

Throws:

NullPointerException - if the name is null.

IllegalArgumentException - if the name is not * or one of the allowed names or a comma-separated list of the allowed names.

exception: NullPointerException - if the name is null.

exception: IllegalArgumentException - if the name is not * or one of the allowed names or a comma-separated list of the allowed names.

 MBeanServerPermission(int mask) {
        super(getCanonicalName(mask));
        this.mask = impliedMask(mask);
}

 public MBeanServerPermission(String name,
    String actions) {
        super(getCanonicalName(parseMask(name)), actions);
        /* It's annoying to have to parse the name twice, but since
           Permission.getName() is final and since we can't access "this"
           until after the call to the superclass constructor, there
           isn't any very clean way to do this.  MBeanServerPermission
           objects aren't constructed very often, luckily.  */
        mask = parseMask(name);
        /* Check that actions is a null empty string */
        if (actions != null && actions.length()  > 0)
            throw new IllegalArgumentException("MBeanServerPermission " +
                                               "actions must be null: " +
                                               actions);
}

Create a new MBeanServerPermission with the given name.

Parameters:

name - the name of the granted permission. It must respect the constraints spelt out in the description of the MBeanServerPermission class.

actions - the associated actions. This parameter is not currently used and must be null or the empty string.

Throws:

NullPointerException - if the name is null.

IllegalArgumentException - if the name is not * or one of the allowed names or a comma-separated list of the allowed names, or if actions is a non-null non-empty string.

NullPointerException - if name is null.

IllegalArgumentException - if name is empty or if arguments are invalid.

exception: NullPointerException - if the name is null.

exception: IllegalArgumentException - if the name is not * or one of the allowed names or a comma-separated list of the allowed names, or if actions is a non-null non-empty string.

Method from javax.management.MBeanServerPermission Summary:
equals, getCanonicalName, hashCode, impliedMask, implies, newPermissionCollection, simplifyMask

Methods from java.security.BasicPermission:
equals, getActions, getCanonicalName, hashCode, implies, newPermissionCollection

Methods from java.security.Permission:
checkGuard, equals, getActions, getName, hashCode, implies, newPermissionCollection, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.management.MBeanServerPermission Detail:
public boolean equals(Object obj) { if (obj == this) return true; if (! (obj instanceof MBeanServerPermission)) return false; MBeanServerPermission that = (MBeanServerPermission) obj; return (this.mask == that.mask); } Checks two MBeanServerPermission objects for equality. Checks that obj is an MBeanServerPermission, and represents the same list of allowable actions as this object.
static String getCanonicalName(int mask) { if (mask == ALL_MASK) return "*"; mask = simplifyMask(mask); synchronized (canonicalNames) { if (canonicalNames[mask] == null) canonicalNames[mask] = makeCanonicalName(mask); } return canonicalNames[mask]; }
public int hashCode() { return mask; }
static int impliedMask(int mask) { if ((mask & CREATE_MASK) != 0) mask \|= NEW_MASK; return mask; }
public boolean implies(Permission p) { if (!(p instanceof MBeanServerPermission)) return false; MBeanServerPermission that = (MBeanServerPermission) p; return ((this.mask & that.mask) == that.mask); } Checks if this MBeanServerPermission object "implies" the specified permission. More specifically, this method returns true if: p is an instance of MBeanServerPermission, p's target names are a subset of this object's target names The `createMBeanServer` permission implies the `newMBeanServer` permission.
public PermissionCollection newPermissionCollection() { return new MBeanServerPermissionCollection(); }
static int simplifyMask(int mask) { if ((mask & CREATE_MASK) != 0) mask &= ~NEW_MASK; return mask; }