javax.tv.service.selection.ServiceContextPermission Maven / Gradle / Ivy
/**
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative use only. For example,
this file and any files generated from it may be used to generate other documentation,
such as a unified set of documents of API signatures for a platform
that includes technologies expressed as Java APIs.
This file may also be used to produce "compilation stubs,"
which allow applications to be compiled and validated for such platforms.
By contrast, no permission is given for you to incorporate this file,
in whole or in part, in an implementation of a Java specification.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 927: Java TV API 1.1.1.
In the event of a discrepency between this work and the JSR 927 specification,
which is available at http://www.jcp.org/en/jsr/detail?id=927, the latter takes precedence.
*/
package javax.tv.service.selection;
import java.security.Permission;
import java.security.BasicPermission;
import javax.tv.locator.Locator;
import java.io.Serializable;
/**
* ServiceContextPermission represents permission to
* control a ServiceContext. A
* ServiceContextPermission contains a name (also
* referred to as a "target name") and an actions string.
*
*
The target name is the name of the service context permission
* (see the table below). Each permission identifies a method. A
* wildcard match is signified by an asterisk, i.e., "*".
*
*
The actions string is either "own" or
* "*".
* A caller's "own" service contexts are those which it has created through
* {@link ServiceContextFactory#createServiceContext}. In addition, an
* Xlet's "own" ServiceContext is the one in which it is currently running
* (see {@link ServiceContextFactory#getServiceContext(XletContext)}).
* The string "own" means
* the permission applies to your own service contexts; the string "*"
* implies permission to these, plus permission for service contexts
* obtained from all other sources.
*
*
The following table lists all the possible
* ServiceContextPermission target names, and describes
* what the permission allows for each.
*
*
*
* Permission Target Name
* What the Permission Allows
*
*
*
* access
* Access to a ServiceContext, via ServiceContextFactory.getServiceContexts()
*
*
*
* create
* Creation of a ServiceContext.
*
*
*
* destroy
* Destruction of a ServiceContext.
*
*
*
* getServiceContentHandlers
* Obtaining the service content handlers from a ServiceContext.
*
*
*
* stop
* Stopping a ServiceContext.
*
*
*
*
*
* The permission ServiceContextPermission("access", "*")
* is intended to be granted only to special monitoring applications and
* not to general broadcast applications.
* In order to properly safeguard service context access, an Xlet's
* {@link javax.microedition.xlet.XletContext} instance should only be
* accessible to another application if that other application has
* ServiceContextPermission("access", "*").
*
*
* Note that undefined target and actions strings may be provided to
* the constructors of this class, but subsequent calls to
* SecurityManager.checkPermission() with the resulting
* SelectPermission object will fail.
*
* @see java.security.BasicPermission
* @see java.security.Permission
* @see ServiceContext
* @see ServiceContextFactory
*
* @version 1.25, 11/01/05
* @author Bill Foote
*/
public final class ServiceContextPermission extends BasicPermission
{
/**
* @serial the actions string
*/
private String actions;
/**
* Creates a new ServiceContextPermission object with the specified
* name. The name is the symbolic name of the permission, such as
* "create". An asterisk may be used to signify a wildcard match.
*
* @param name The name of the ServiceContextPermission
*
* @param actions The actions string, as
* detailed in the class description.
*/
public ServiceContextPermission(String name, String actions) {
super(name);
}
/**
* Checks if the specified permission is "implied" by this object.
*
* More specifically, this method returns true if:
*
* - p is an instance of ServiceContextPermission, and
*
- p's action string matches this object's, or this object has
* "*" as an action string, and
*
- p's locator's external form matches this object's locator
* string, or this object's locator string is "*".
*
*
* @param p The permission against which to test.
*
* @return true if the specified permission is equal
* to or implied by this permission; false otherwise.
*
*/
public boolean implies(Permission p) {
return false;
}
/**
* Tests two ServiceContextPermission objects for
* equality. Returns true if and only if
* obj's class is the same as the class of this
* object, and obj has the same name and actions
* string as this object.
*
* @param obj The object to test for equality.
*
* @return true if the two permissions are equal;
* false otherwise.
*/
public boolean equals(Object obj) {
return false;
}
/**
* Provides the hash code value of this object. Two
* ServiceContextPermission objects that are equal will
* return the same hash code.
*
* @return The hash code value of this object.
*/
public int hashCode() {
return 0;
}
/**
* Returns the canonical representation of the actions string.
*
* @return The actions string of this permission.
*/
public String getActions() {
return null;
}
}