jdk.dio

Class DeviceMgmtPermission

java.lang.Object

java.security.Permission

jdk.dio.DeviceMgmtPermission

All Implemented Interfaces:

java.io.Serializable, java.security.Guard

public class DeviceMgmtPermission
extends java.security.Permission

The DeviceMgmtPermission class defines permissions for registering and unregistering devices as well as opening devices using their registered configurations.

Device management permissions have a target name and actions.

The target name is a combination of a device name and of a device ID or range of device IDs. It takes the following form:

{device-name-spec} [ ":"{device-id-spec} ]

{device-name-spec}

The {device-name-spec} string takes the following form:

{device-name} | "*" | ""

The {device-name}string is a device name as may be returned by a call to DeviceDescriptor.getName.
A {device-name-spec} specification consisting of the asterisk ("*") matches all device names. A {device-name-spec} specification consisting of the empty string ("") designates an undefined device name that may only be matched by an empty string or an asterisk.

{device-id-spec}

The {device-id-spec} string takes the following form:

{device-id} | "-"{device-id} | {device-id}"-"[{device-id}] | "*"

The {device-id} string is a device ID as may be returned by a call to DeviceDescriptor.getID. The characters in the string must all be decimal digits.
A {device-id-spec} specification of the form "N-" (where N is a device ID) signifies all device IDs numbered N and above, while a specification of the form "-N" indicates all device IDs numbered N and below. A single asterisk in the place of the {device-id-spec} field matches all device IDs.

The target name "*:*" matches all device names and all device IDs as is the target name "*".

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 register and unregister. Their meaning is defined as follows:

open

open a device using its device ID or name (see DeviceManager.open(id, ...) and DeviceManager.open(name, ...) methods)

register

register a new device

unregister

unregister a device

See Also:

DeviceManager.open, DeviceManager.register, DeviceManager.unregister, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPEN The open action.
static java.lang.String	REGISTER The register action.
static java.lang.String	UNREGISTER The unregister action.

Constructor Summary

Constructors

Constructor and Description
DeviceMgmtPermission(java.lang.String name, java.lang.String actions) Constructs a new DeviceMgmtPermission instance with the specified target name and action list.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two DeviceMgmtPermission objects for equality.
java.lang.String	getActions() Returns the list of possible actions in the following order: register, unregister or open.
int	hashCode() Returns the hash code value for this object.
boolean	implies(java.security.Permission permission) Checks if this DeviceMgmtPermission object "implies" the specified permission.
java.security.PermissionCollection	newPermissionCollection() Returns a new PermissionCollection for storing DeviceMgmtPermission 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

Field Detail

REGISTER

public static final java.lang.String REGISTER

The register action.

See Also:

Constant Field Values

UNREGISTER

public static final java.lang.String UNREGISTER

The unregister action.

See Also:

Constant Field Values

OPEN

public static final java.lang.String OPEN

The open action.

See Also:

Constant Field Values

Constructor Detail

DeviceMgmtPermission

public DeviceMgmtPermission(java.lang.String name,
                    java.lang.String actions)

Constructs a new DeviceMgmtPermission instance with the specified target name and action list.

Parameters:

name - the target name (as defined above).

actions - comma-separated list of device management operations: register unregister or open.

Throws:

java.lang.NullPointerException - if name is null.

java.lang.IllegalArgumentException - if actions is null, empty or contains an action other than the specified possible actions.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Checks two DeviceMgmtPermission objects for equality.

Specified by:

equals in class java.security.Permission

Parameters:

obj - the object to test for equality with this object.

Returns:

true if obj is a DeviceMgmtPermission and has the same target name and actions as this DeviceMgmtPermission object.

getActions

public java.lang.String getActions()

Returns the list of possible actions in the following order: register, unregister or open.

Specified by:

getActions in class java.security.Permission

Returns:

comma-separated list of possible actions.

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.

implies

public boolean implies(java.security.Permission permission)

Checks if this DeviceMgmtPermission object "implies" the specified permission.

More specifically, this method returns true if:

• permission is an instance of DeviceMgmtPermission, and
• permission's actions are a proper subset of this action list, and
• permission's device name, ID or range thereof is included in this device name or ID range, whichever is defined.

Specified by:

implies in class java.security.Permission

Parameters:

permission - the permission to check against.

Returns:

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

newPermissionCollection

public java.security.PermissionCollection newPermissionCollection()

Returns a new PermissionCollection for storing DeviceMgmtPermission objects.

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

If null is returned, then the caller of this method is free to store permissions of this type in any PermissionCollection they choose (one that uses a Hashtable, one that uses a Vector, etc).

Overrides:

newPermissionCollection in class java.security.Permission

Returns:

a new PermissionCollection suitable for storing DeviceMgmtPermission objects, or null if one is not defined.