OSGi™ Service Platform
Release 2

org.osgi.framework
Class ServicePermission

java.lang.Object
  extended byjava.security.Permission
      extended byjava.security.BasicPermission
          extended byorg.osgi.framework.ServicePermission
All Implemented Interfaces:
java.security.Guard, java.io.Serializable

public final class ServicePermission
extends java.security.BasicPermission

Indicates a bundle's authority to register or get a service.

Permission to get a service is required in order to detect events regarding the service. Untrusted bundles should not be able to detect the presence of certain services unless they have the appropriate ServicePermission to get the specific service.

See Also:
Serialized Form

Field Summary
static java.lang.String GET
          The action string get (Value is "get").
static java.lang.String REGISTER
          The action string register (Value is "register").
 
Constructor Summary
ServicePermission(java.lang.String name, java.lang.String actions)
          Create a new ServicePermission.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Determines the equalty of two ServicePermission objects.
 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)
          Determines if a ServicePermission object "implies" the specified permission.
 java.security.PermissionCollection newPermissionCollection()
          Returns a new PermissionCollection object for storing ServicePermission 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

GET

public static final java.lang.String GET
The action string get (Value is "get").

See Also:
Constant Field Values

REGISTER

public static final java.lang.String REGISTER
The action string register (Value is "register").

See Also:
Constant Field Values
Constructor Detail

ServicePermission

public ServicePermission(java.lang.String name,
                         java.lang.String actions)
Create a new ServicePermission.

The name of the service is specified as a fully qualified class name.

 ClassName ::= <class name> | <class name ending in ".*">
 
Examples:
    org.osgi.service.http.HttpService
    org.osgi.service.http.*
    org.osgi.service.snmp.*
 

There are two possible actions: get and register. The get permission allows the owner of this permission to obtain a service with this name. The register permission allows the bundle to register a service under that name.

Parameters:
name - class name
actions - get, register (canonical order)
Method Detail

implies

public boolean implies(java.security.Permission p)
Determines if a ServicePermission object "implies" the specified permission.

Parameters:
p - The target permission to check.
Returns:
true if the specified permission is implied by this object; false otherwise.

getActions

public java.lang.String getActions()
Returns the canonical string representation of the actions. Always returns present actions in the following order: get, register.

Returns:
The canonical string representation of the actions.

newPermissionCollection

public java.security.PermissionCollection newPermissionCollection()
Returns a new PermissionCollection object for storing ServicePermission objects.

Returns:
A new PermissionCollection object suitable for storing ServicePermission objects.

equals

public boolean equals(java.lang.Object obj)
Determines the equalty of two ServicePermission objects. Checks that specified object has the same class name and action as this ServicePermission.

Parameters:
obj - The object to test for equality.
Returns:
true if obj is a ServicePermission, and has the same class name and actions as this ServicePermission object; false otherwise.

hashCode

public int hashCode()
Returns the hash code value for this object.

Returns:
Hash code value for this object.

OSGi™ Service Platform
Release 2

Copyright © OSGi Alliance (2000, 2002). All Rights Reserved. Licensed under the OSGi Specification License, Version 1.0