javax.microedition.media

Class PlayerPermission

java.lang.Object

java.security.Permission

javax.microedition.media.PlayerPermission

All Implemented Interfaces:

java.io.Serializable, java.security.Guard

public final class PlayerPermission
extends java.security.Permission

This class is for Media Player permissions.

Care should be taken before granting permission to record or make a snapshot. See the Addendum: Multi-media security for details.

The name is the locator of the resource for which snapshot or record is to be allowed. If name is "*" it applies to all locators. If the last character of the locator is "*", the permission applies to all locators that start with the name (without the "*").

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 "record" and "snapshot". Their meaning is defined as follows:

record

record permission. Allows RecordControl.setRecordLocation(java.lang.String) and RecordControl.setRecordStream(java.io.OutputStream) to be used

snapshot

snapshot permission. Allows VideoControl.getSnapshot(java.lang.String) to be used

The actions string is converted to lowercase before processing.

See Also:

Permission, SecurityManager

Constructor Summary

Constructors

Constructor and Description
PlayerPermission(java.lang.String name, java.lang.String actions) Creates a new PlayerPermission object with the specified name and actions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two PlayerPermission 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 PlayerPermission object "implies" the specified permission.
java.security.PermissionCollection	newPermissionCollection() Returns a new PermissionCollection for storing PlayerPermission 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

PlayerPermission

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

Creates a new PlayerPermission object with the specified name and actions. name is the locator to which the permissions apply. actions contains a comma-separated list of the desired actions granted on the property. Possible actions are "record" and "snapshot".

Parameters:

name - the locator to which the permission applies.

actions - the actions string.

Throws:

java.lang.NullPointerException - if name or actions is null.

java.lang.IllegalArgumentException - if action is invalid or if name is zero length.

Method Detail

implies

public boolean implies(java.security.Permission p)

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

More specifically, this method returns true if:

• p is an instanceof PlayerPermission,

• p's actions are a subset of this object's actions.
• p's name is implied by this object's name:
  • if this object's name does not end in "*" and this object's name is equal to p's name.
  • if this object's name ends in "*" and this object's name, without the final "*", is a prefix of p's name.
  For example, "*" implies any other locator, "capture:*" implies "capture://audio".

Specified by:

implies in class java.security.Permission

Parameters:

p - the permission to check against.

Returns:

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

equals

public boolean equals(java.lang.Object obj)

Checks two PlayerPermission objects for equality. Checks that obj is a PlayerPermission, and has the same name and actions as this object.

Specified by:

equals in class java.security.Permission

Parameters:

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

Returns:

true if obj is a PlayerPermission, and has the same name and actions as this PlayerPermission object.

hashCode

public int hashCode()

Returns the hash code value for this object. The value returned complies with the requirements of the the hashCode method of the superclass.

Specified by:

hashCode in class java.security.Permission

Returns:

a hash code value for this object.

getActions

public java.lang.String getActions()

Returns the "canonical string representation" of the actions. That is, this method always returns present actions in the following order: record, snapshot. For example, if this PlayerPermission object allows both record and snapshot actions, a call to getActions will return the string "record,snapshot".

Specified by:

getActions in class java.security.Permission

Returns:

the canonical string representation of the actions.

newPermissionCollection

public java.security.PermissionCollection newPermissionCollection()

Returns a new PermissionCollection for storing PlayerPermission objects.

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

Overrides:

newPermissionCollection in class java.security.Permission

Returns:

a new PermissionCollection suitable for storing PlayerPermission objects.