javax.management
Class MBeanServerPermission

java.lang.Object
  |
  +--java.security.Permission
        |
        +--java.security.BasicPermission
              |
              +--javax.management.MBeanServerPermission

public class MBeanServerPermission

extends java.security.BasicPermission

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(java.lang.String).

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(javax.management.MBeanServer).

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").

See Also:

Serialized Form

Constructor Summary

MBeanServerPermission(java.lang.String name)
Create a new MBeanServerPermission with the given name.

MBeanServerPermission(java.lang.String name, java.lang.String actions)
Create a new MBeanServerPermission with the given name.

Method Summary

boolean	equals(java.lang.Object obj) Checks two MBeanServerPermission objects for equality.
java.lang.String	getActions() Returns the "canonical string representation" of the actions.
int	hashCode() Returns the hash code value for this object.
boolean	implies(java.security.Permission p) Checks if this MBeanServerPermission object "implies" the specified permission.
java.security.PermissionCollection	newPermissionCollection() Returns a new PermissionCollection object for storing MBeanServerPermission objects.

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

Constructor Detail

MBeanServerPermission

public MBeanServerPermission(java.lang.String name)

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:

java.lang.NullPointerException - if the name is null.

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

MBeanServerPermission

public MBeanServerPermission(java.lang.String name,
                             java.lang.String 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:

java.lang.NullPointerException - if the name is null.

java.lang.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 Detail

implies

public boolean implies(java.security.Permission p)

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.

Overrides:

implies in class java.security.BasicPermission

Parameters:

p - the permission to check against.

Returns:

true if the specified permission is implied by this object, false if not.

newPermissionCollection

public java.security.PermissionCollection newPermissionCollection()

Returns a new PermissionCollection object for storing MBeanServerPermission objects.

A PermissionCollection stores a collection of MBeanServerPermission permissions.

MBeanServerPermission objects must be stored in a manner that allows them to be inserted in any order, but that also enables the PermissionCollection implies method to be implemented in an efficient (and consistent) manner.

Overrides:

newPermissionCollection in class java.security.BasicPermission

Returns:

a new PermissionCollection object suitable for storing MBeanServerPermissions.

equals

public boolean equals(java.lang.Object obj)

Checks two MBeanServerPermission objects for equality. Checks that obj is an MBeanServerPermission, and represents the same list of allowable actions as this object.

Overrides:

equals in class java.security.BasicPermission

Parameters:

obj - the object we are testing for equality with this object.

Returns:

true if the objects are equal.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.security.BasicPermission

Returns:

a hash code value for this object.

getActions

public java.lang.String getActions()

Returns the "canonical string representation" of the actions. As this parameter is not currently used and this will return an empty string.

Overrides:

getActions in class java.security.BasicPermission

Returns:

the canonical string representation of the actions and returns an empty string as this is not currently used.