* Represents the permissions required to perform * operations provided by the {@link MBeanServerFactory}. * As with all {@link java.security.Permission} objects, an * instance of this class either represents a permission * already held or one that is required to access a * particular service. In the case of {@link MBeanServerPermission}s, * implication checks are made using an instance of this class * when a user requests an operation from the factory, and a * {@link SecurityManager} is in place. *
*
* The permission is defined by its name, which may be
* either a '*' (to allow all) or one or
* more of the following, separated by a ',':
*
createMBeanServer -- allows a registered
* instance of a server to be obtained from the factory.findMBeanServer -- allows all or one
* particular server instance to be retrieved from the factory.newMBeanServer -- allows an unregistered
* instance of a server to be obtained from the factory.releaseMBeanServer -- allows a reference to
* a server instance to be removed from the factory.
* The names may be surrounded by arbitrary amounts of whitespace.
* createMBeanServer implies newMBeanServer.
*
* Constructs a new {@link MBeanServerPermission} with
* the given name. The name must not be null
* and must be equal to either "*" or a
* comma-separated list of valid permissions. The four
* valid constraints are:
*
createMBeanServerfindMBeanServernewMBeanServerreleaseMBeanServer
* Calling this constructor is equivalent to calling
* MBeanPermission(name, null).
*
name
* is null.
* @throws IllegalArgumentException if name
* is not either equal to
* "*" or forms
* a comma-separated list of
* valid constraints.
* @see #MBeanServerPermission(String,String)
*/
public MBeanServerPermission(String name)
{
this(name, null);
}
/**
*
* Constructs a new {@link MBeanServerPermission} with
* the given name and actions. The actions are unused,
* and must be either null or the empty
* string. The name must not be null
* and must be equal to either "*" or a
* comma-separated list of valid permissions. The four
* valid constraints are:
*
createMBeanServerfindMBeanServernewMBeanServerreleaseMBeanServer
* Calling this constructor is equivalent to calling
* MBeanPermission(name, null).
*
name
* is null.
* @throws IllegalArgumentException if name
* is not either equal to
* "*" or forms
* a comma-separated list of
* valid constraints, or if
* actions is not
* null or the
* empty string.
* @see #MBeanServerPermission(String,String)
*/
public MBeanServerPermission(String name, String actions)
{
super(checkName(name), actions);
if (actions != null && actions.length() > 0)
throw new IllegalArgumentException("The supplied action list " +
"was not equal to null or the " +
"empty string.");
}
/**
* Returns true if the given object is also an {@link MBeanServerPermission}
* with the same name.
*
* @param obj the object to compare with this one.
* @return true if the object is an {@link MBeanPermission}
* with the same name.
*/
public boolean equals(Object obj)
{
if (obj instanceof MBeanServerPermission)
{
MBeanServerPermission o = (MBeanServerPermission) obj;
return o.getName().equals(getName());
}
return false;
}
/**
* Returns a unique hash code for this permission.
* This is simply the hashcode of {@link BasicPermission#getName()}.
*
* @return the hashcode of this permission.
*/
public int hashCode()
{
return getName().hashCode();
}
/**
* Returns true if this {@link MBeanServerPermission} implies
* the given permission. This occurs if the given permission
* is also an {@link MBeanServerPermission} and its target names
* are a subset of the target names of this permission. Note that
* the name createMBeanServer implies
* newMBeanServer.
*
* @param p the permission to check for implication.
* @return true if this permission implies p.
*/
public boolean implies(Permission p)
{
if (p instanceof MBeanServerPermission)
{
if (getName().equals("*"))
return true;
MBeanServerPermission msp = (MBeanServerPermission) p;
String[] thisCaps = getName().split(",");
String[] mspCaps = msp.getName().split(",");
for (int a = 0; a < mspCaps.length; ++a)
{
boolean found = false;
String mc = mspCaps[a].trim();
for (int b = 0; b < thisCaps.length; ++b)
{
String tc = thisCaps[b].trim();
if (tc.equals(mc))
found = true;
if (tc.equals("createMBeanServer") &&
mc.equals("newMBeanServer"))
found = true;
}
if (!found)
return false;
}
return true;
}
return false;
}
/**
* Returns a {@link PermissionCollection} which stores
* a series of {@link MBeanServerPermission}s as the union
* of their capabilities.
*
* @return a collection for {@link MBeanServerPermission}s.
*/
public PermissionCollection newPermissionCollection()
{
return new MBeanServerPermissionCollection();
}
/**
* A collection of {@link MBeanServerPermission}s, stored
* as a single permission with the union of the capabilities
* as its capabilities.
*
* @author Andrew John Hughes (gnu_andrew@member.fsf.org)
* @since 1.5
*/
private class MBeanServerPermissionCollection
extends PermissionCollection
{
/**
* Compatible with JDK 1.5
*/
private static final long serialVersionUID = -5661980843569388590L;
/**
* The collected permission. This is null or
* the union of the permissions held by all the collected
* permissions.
*/
private MBeanServerPermission collectionPermission;
/**
* Adds a new permission by unifying it with the existing
* collection permission.
*
* @param p the permission to add.
* @throws SecurityException if the collection is read only.
* @see #isReadOnly()
* @see #setReadOnly(boolean)
*/
@Override
public void add(Permission p)
{
if (isReadOnly())
throw new SecurityException("This collection is read only.");
if (p instanceof MBeanServerPermission)
{
MBeanServerPermission msp = (MBeanServerPermission) p;
if (collectionPermission == null)
collectionPermission = msp;
else
{
String finalString = collectionPermission.getName();
String[] cp = finalString.split(",");
String[] np = msp.getName().split(",");
int createms = finalString.indexOf("createMBeanServer");
int newms = finalString.indexOf("newMBeanServer");
for (int a = 0; a < np.length; ++a)
{
boolean found = false;
String nps = np[a].trim();
for (int b = 0; b < cp.length; ++b)
{
String cps = cp[b].trim();
if (cps.equals(nps))
found = true;
if (nps.equals("newMBeanServer")
&& createms != -1)
found = true;
if (nps.equals("createMBeanServer")
&& newms != -1)
finalString =
finalString.replace("newMBeanServer",
"createMBeanServer");
}
if (!found)
finalString += "," + nps;
}
collectionPermission =
new MBeanServerPermission(finalString);
}
}
}
/**
* Returns an enumeration over the single permission.
*
* @return an enumeration over the collection permission.
*/
@Override
public EnumerationcreateMBeanServer implies
* newMBeanServer.
*
* @param p the permission to check for implication.
* @return true if this permission implies p.
*/
@Override
public boolean implies(Permission p)
{
return collectionPermission.implies(p);
}
}
/**
* Checks the name is valid, including removing
* the newMBeanServer permission when
* createMBeanServer is present.
*
* @param name the name to check.
* @throws NullPointerException if name
* is null.
* @throws IllegalArgumentException if name
* is not either equal to
* "*" or forms
* a comma-separated list of
* valid constraints.
*/
private static String checkName(String name)
{
if (!(name.equals("*")))
{
String[] constraints = name.split(",");
name = "";
boolean seenCreate = false;
boolean seenNew = false;
boolean start = true;
for (int a = 0; a < constraints.length; ++a)
{
String next = constraints[a].trim();
if (!(next.equals("createMBeanServer") ||
next.equals("findMBeanServer") ||
next.equals("newMBeanServer") ||
next.equals("releaseMBeanServer")))
throw new IllegalArgumentException("An invalid constraint, " +
next + ", was specified.");
if (next.equals("newMBeanServer"))
seenNew = true;
else if (next.equals("createMBeanServer"))
seenCreate = true;
else
{
if (!start)
name += ",";
name += next;
start = false;
}
}
if (seenNew && !seenCreate)
name += (start ? "" : ",") + "newMBeanServer";
else if (seenCreate)
name += (start ? "" : ",") + "createMBeanServer";
}
return name;
}
}