com.oracle.deviceaccess.gpio

Class GPIOPinPermission

java.lang.Object

java.security.Permission

com.oracle.deviceaccess.PeripheralPermission

com.oracle.deviceaccess.gpio.GPIOPinPermission

All Implemented Interfaces:

java.io.Serializable, java.security.Guard

public class GPIOPinPermission
extends PeripheralPermission

The GPIOPinPermission class defines permissions for GPIO pin access.

A GPIOPinPermission permission has a target name and a list of actions.

The target name contains hardware addressing information. The format is the one defined for the base PeripheralPermission class with the following addition:

{channel-spec}

The {channel-spec} string (described in PeripheralPermission) is the decimal string representation of a pin number as may be returned by a call to GPIOPinConfig.getPinNumber(). The characters in the string must all be decimal digits.

The supported actions are open, powermanage or setdirection. Their meaning is defined as follows:

open

open and access a GPIO pin functions (see PeripheralManager.open)

setdirection

change GPIO pin direction (see GPIOPin.setDirection)

powermanage

manage the power saving mode of a peripheral device (see PowerManaged)

See Also:

PeripheralManager.open, PowerManaged, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SET_DIRECTION The setdirection action.

Fields inherited from class com.oracle.deviceaccess.PeripheralPermission

OPEN, POWER_MANAGE

Constructor Summary

Constructors

Constructor and Description
GPIOPinPermission(java.lang.String name) Constructs a new GPIOPinPermission with the specified target name and the implicit open action.
GPIOPinPermission(java.lang.String name, java.lang.String actions) Constructs a new GPIOPinPermission 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 GPIOPinPermission objects for equality.
java.lang.String	getActions() Returns the list of possible actions in the following order: open, powermanage or setdirection.
int	hashCode() Returns the hash code value for this object.
boolean	implies(java.security.Permission permission) Checks if this GPIOPinPermission object "implies" the specified permission.
java.security.PermissionCollection	newPermissionCollection() Returns a new PermissionCollection for storing GPIOPinPermission 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

SET_DIRECTION

public static final java.lang.String SET_DIRECTION

The setdirection action.

See Also:

Constant Field Values

Constructor Detail

GPIOPinPermission

public GPIOPinPermission(java.lang.String name)

Constructs a new GPIOPinPermission with the specified target name and the implicit open action.

Parameters:

name - the target name (as defined above).

Throws:

java.lang.NullPointerException - if name is null.

See Also:

Permission.getName()

GPIOPinPermission

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

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

Parameters:

name - the target name (as defined above).

actions - comma-separated list of peripheral operations: open, powermanage or setdirection.

Throws:

java.lang.NullPointerException - if name is null.

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

See Also:

Permission.getName()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Checks two GPIOPinPermission objects for equality.

Overrides:

equals in class PeripheralPermission

Parameters:

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

Returns:

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

getActions

public java.lang.String getActions()

Returns the list of possible actions in the following order: open, powermanage or setdirection.

Overrides:

getActions in class PeripheralPermission

Returns:

comma-separated list of possible actions.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class PeripheralPermission

Returns:

a hash code value for this object.

implies

public boolean implies(java.security.Permission permission)

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

More specifically, this method returns true if:

• permission is an instance of GPIOPinPermission, and
• permission's actions are a proper subset of this object's action list, and
• permission's peripheral ID, name, hardware addressing information or range thereof is included in this peripheral ID, name or hardware addressing information range, whichever is defined.

Overrides:

implies in class PeripheralPermission

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 GPIOPinPermission objects.

GPIOPinPermission 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 PeripheralPermission

Returns:

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