OpenJDK 27 · javax.management.MBeanServerPermission · APIdia, the JavaDoc alternative

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

Field Summary

Modifier and Type	Field and Description
private static final int	ALL_MASK
private static final String[]	canonicalNames
private static final int	CREATE
private static final int	CREATE_MASK
private static final int	FIND
private static final int	FIND_MASK
pack-priv transient int	mask
private static final int	N_NAMES
private static final String[]	names
private static final int	NEW
private static final int	NEW_MASK
private static final int	RELEASE
private static final int	RELEASE_MASK
private static final long	serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	MBeanServerPermission(String the name of the granted permission. It must respect the constraints spelt out in the description of the `MBeanServerPermission` class. name) Create a new MBeanServerPermission with the given name.
public	MBeanServerPermission(String the name of the granted permission. It must respect the constraints spelt out in the description of the `MBeanServerPermission` class. name, String the associated actions. This parameter is not currently used and must be null or the empty string. actions) Create a new MBeanServerPermission with the given name.
pack-priv	MBeanServerPermission(int mask)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the objects are equal. equals(Object the object we are testing for equality with this object. obj) Overrides java.security.BasicPermission.equals. Checks two MBeanServerPermission objects for equality.
pack-priv static String	getCanonicalName(int mask)
public int	hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object.
pack-priv static int	impliedMask(int mask)
public boolean	Returns: true if the specified permission is implied by this object, false if not. implies(Permission the permission to check against. p) Overrides java.security.BasicPermission.implies. Checks if this MBeanServerPermission object "implies" the specified permission.
private static String	makeCanonicalName(int mask)
private static int	nameIndex(String name)
public PermissionCollection	newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object for storing `BasicPermission` objects.
private static int	parseMask(String name)
private void	readObject(ObjectInputStream in) Hides java.security.BasicPermission.readObject. `readObject` is called to restore the state of the `BasicPermission` from a stream.
pack-priv static int	simplifyMask(int mask)

Inherited from java.security.BasicPermission:: getActions

Field Detail

ALL_MASK	back to summary
private static final int ALL_MASK

canonicalNames	back to summary
private static final String[] canonicalNames

CREATE	back to summary
private static final int CREATE

CREATE_MASK	back to summary
private static final int CREATE_MASK

FIND	back to summary
private static final int FIND

FIND_MASK	back to summary
private static final int FIND_MASK

mask	back to summary
pack-priv transient int mask

N_NAMES	back to summary
private static final int N_NAMES

names	back to summary
private static final String[] names

NEW	back to summary
private static final int NEW

NEW_MASK	back to summary
private static final int NEW_MASK

RELEASE	back to summary
private static final int RELEASE

RELEASE_MASK	back to summary
private static final int RELEASE_MASK

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Constructor Detail

MBeanServerPermission back to summary

MBeanServerPermission	back to summary
public MBeanServerPermission(String name) Create a new MBeanServerPermission with the given name. This constructor is equivalent to `MBeanServerPermission(name,null)`. Parameters name:String the name of the granted permission. It must respect the constraints spelt out in the description of the `MBeanServerPermission` class. Exceptions 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.

public MBeanServerPermission(String name)

Create a new MBeanServerPermission with the given name.

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

Parameters

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

Exceptions

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.

MBeanServerPermission back to summary

MBeanServerPermission	back to summary
public MBeanServerPermission(String name, String actions) Create a new MBeanServerPermission with the given name. Parameters name:String the name of the granted permission. It must respect the constraints spelt out in the description of the `MBeanServerPermission` class. actions:String the associated actions. This parameter is not currently used and must be null or the empty string. Exceptions NullPointerException: if the name is null. if `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. if `name` is empty or if arguments are invalid.

public MBeanServerPermission(String name, String actions)

Create a new MBeanServerPermission with the given name.

Parameters

name:String: the name of the granted permission. It must respect the constraints spelt out in the description of the MBeanServerPermission class.
actions:String: the associated actions. This parameter is not currently used and must be null or the empty string.

Exceptions

NullPointerException:

if the name is null.
if 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.
if name is empty or if arguments are invalid.

MBeanServerPermission	back to summary
pack-priv MBeanServerPermission(int mask)

Method Detail

equals	back to summary
public boolean equals(Object obj) Overrides java.security.BasicPermission.equals. Checks two MBeanServerPermission objects for equality. Checks that obj is an MBeanServerPermission, and represents the same list of allowable actions as this object. Parameters obj:Object the object we are testing for equality with this object. Returns:boolean true if the objects are equal.

equals

back to summary

public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

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

Parameters

obj:Object: the object we are testing for equality with this object.

Returns:boolean

true if the objects are equal.

getCanonicalName	back to summary
pack-priv static String getCanonicalName(int mask)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.security.BasicPermission.hashCode. Doc from java.security.BasicPermission.hashCode. Returns the hash code value for this object. The hash code used is the hash code of the name, that is, `getName().hashCode()`, where `getName` is from the `Permission` superclass.

public int hashCode()

Overrides java.security.BasicPermission.hashCode.

Doc from java.security.BasicPermission.hashCode.

Returns the hash code value for this object. The hash code used is the hash code of the name, that is, getName().hashCode(), where getName is from the Permission superclass.

impliedMask	back to summary
pack-priv static int impliedMask(int mask)

implies back to summary

implies	back to summary
public boolean implies(Permission p) Overrides java.security.BasicPermission.implies. 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. Parameters p:Permission the permission to check against. Returns:boolean true if the specified permission is implied by this object, false if not.

public boolean implies(Permission p)

Overrides java.security.BasicPermission.implies.

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.

Parameters

p:Permission: the permission to check against.

Returns:boolean

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

makeCanonicalName	back to summary
private static String makeCanonicalName(int mask)

nameIndex	back to summary
private static int nameIndex(String name) throws IllegalArgumentException

newPermissionCollection back to summary

newPermissionCollection	back to summary
public PermissionCollection newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Doc from java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object for storing `BasicPermission` objects. `BasicPermission` 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.

public PermissionCollection newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Doc from java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection object for storing BasicPermission objects.

BasicPermission 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.

parseMask	back to summary
private static int parseMask(String name)

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Hides java.security.BasicPermission.readObject. Doc from java.security.BasicPermission.readObject. `readObject` is called to restore the state of the `BasicPermission` from a stream. Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

Hides java.security.BasicPermission.readObject.

Doc from java.security.BasicPermission.readObject.

readObject is called to restore the state of the BasicPermission from a stream.

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

simplifyMask	back to summary
pack-priv static int simplifyMask(int mask)

public Class MBeanServerPermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail