org.osgi.framework.AdminPermission Class Reference

List of all members.


Detailed Description

Indicates the caller's authority to perform specific privileged administrative operations on or to get sensitive information about a bundle.

The actions for this permission are:

  Action               Methods
  class                Bundle.loadClass
  execute              Bundle.start
                       Bundle.stop
                       StartLevel.setBundleStartLevel
  extensionLifecycle   BundleContext.installBundle for extension bundles
                       Bundle.update for extension bundles
                       Bundle.uninstall for extension bundles
  lifecycle            BundleContext.installBundle
                       Bundle.update
                       Bundle.uninstall
  listener             BundleContext.addBundleListener for SynchronousBundleListener
                       BundleContext.removeBundleListener for SynchronousBundleListener
  metadata             Bundle.getHeaders
                       Bundle.getLocation
  resolve              PackageAdmin.refreshPackages
                       PackageAdmin.resolveBundles
  resource             Bundle.getResource
                       Bundle.getResources
                       Bundle.getEntry
                       Bundle.getEntryPaths
                       Bundle.findEntries
                       Bundle resource/entry URL creation
  startlevel           StartLevel.setStartLevel
                       StartLevel.setInitialBundleStartLevel 
 

The special action "*" will represent all actions.

The name of this permission is a filter expression. The filter gives access to the following parameters:

Definition at line 112 of file AdminPermission.java.


Public Member Functions

 AdminPermission ()
 Creates a new AdminPermission object that matches all bundles and has all actions.
 AdminPermission (String filter, String actions)
 Create a new AdminPermission.
 AdminPermission (Bundle bundle, String actions)
 Creates a new AdminPermission object to be used by the code that must check a Permission object.
boolean equals (Object obj)
 Determines the equality of two AdminPermission objects.
int hashCode ()
 Returns the hash code value for this object.
String getActions ()
 Returns the canonical string representation of the AdminPermission actions.
boolean implies (Permission p)
 Determines if the specified permission is implied by this object.
PermissionCollection newPermissionCollection ()
 Returns a new PermissionCollection object suitable for storing AdminPermissions.

Static Public Attributes

static final String CLASS = "class"
 The action string class (Value is "class").
static final String EXECUTE = "execute"
 The action string execute (Value is "execute").
static final String EXTENSIONLIFECYCLE = "extensionLifecycle"
 The action string extensionLifecycle (Value is "extensionLifecycle").
static final String LIFECYCLE = "lifecycle"
 The action string lifecycle (Value is "lifecycle").
static final String LISTENER = "listener"
 The action string listener (Value is "listener").
static final String METADATA = "metadata"
 The action string metadata (Value is "metadata").
static final String RESOLVE = "resolve"
 The action string resolve (Value is "resolve").
static final String RESOURCE = "resource"
 The action string resource (Value is "resource").
static final String STARTLEVEL = "startlevel"
 The action string startlevel (Value is "startlevel").

Constructor & Destructor Documentation

org.osgi.framework.AdminPermission.AdminPermission (  ) 

Creates a new AdminPermission object that matches all bundles and has all actions.

Equivalent to AdminPermission("*","*");

Definition at line 188 of file AdminPermission.java.

org.osgi.framework.AdminPermission.AdminPermission ( String  filter,
String  actions 
)

Create a new AdminPermission.

This constructor must only be used to create a permission that is going to be checked.

Examples:

 (signer=\*,o=ACME,c=US)   
 (&(signer=\*,o=ACME,c=US)(name=com.acme.*)(location=http://www.acme.com/bundles/*))
 (id>=1)
 

When a signer key is used within the filter expression the signer value must escape the special filter chars ('*', '(', ')').

Null arguments are equivalent to "*".

Parameters:
filter A filter expression that can use signer, location, id, and name keys. A value of "*" or null matches all bundle.
actions class, execute, extensionLifecycle, lifecycle, listener, metadata, resolve, resource, or startlevel. A value of "*" or null indicates all actions

Definition at line 222 of file AdminPermission.java.

org.osgi.framework.AdminPermission.AdminPermission ( Bundle  bundle,
String  actions 
)

Creates a new AdminPermission object to be used by the code that must check a Permission object.

Parameters:
bundle A bundle
actions class, execute, extensionLifecycle, lifecycle, listener, metadata, resolve, resource, startlevel
Since:
1.3

Definition at line 247 of file AdminPermission.java.

References org.osgi.framework.Bundle.getBundleId().


Member Function Documentation

boolean org.osgi.framework.AdminPermission.equals ( Object  obj  ) 

Determines the equality of two AdminPermission objects.

Parameters:
obj The object being compared for equality with this object.
Returns:
true if obj is equivalent to this AdminPermission; false otherwise.

Definition at line 314 of file AdminPermission.java.

References org.osgi.framework.AdminPermission.actionMask, and org.osgi.framework.AdminPermission.bundle.

Referenced by org.osgi.framework.AdminPermission.implies().

int org.osgi.framework.AdminPermission.hashCode (  ) 

Returns the hash code value for this object.

Returns:
Hash code value for this object.

Definition at line 338 of file AdminPermission.java.

String org.osgi.framework.AdminPermission.getActions (  ) 

Returns the canonical string representation of the AdminPermission actions.

Always returns present AdminPermission actions in the following order: class, execute, extensionLifecycle, lifecycle, listener, metadata, resolve, resource, startlevel.

Returns:
Canonical string representation of the AdminPermission actions.

Definition at line 361 of file AdminPermission.java.

References org.osgi.framework.AdminPermission.CLASS, org.osgi.framework.AdminPermission.EXECUTE, org.osgi.framework.AdminPermission.EXTENSIONLIFECYCLE, org.osgi.framework.AdminPermission.LIFECYCLE, org.osgi.framework.AdminPermission.LISTENER, org.osgi.framework.AdminPermission.METADATA, org.osgi.framework.AdminPermission.RESOLVE, org.osgi.framework.AdminPermission.RESOURCE, and org.osgi.framework.AdminPermission.STARTLEVEL.

boolean org.osgi.framework.AdminPermission.implies ( Permission  p  ) 

Determines if the specified permission is implied by this object.

This method throws an exception if the specified permission was not constructed with a bundle.

This method returns true if the specified permission is an AdminPermission AND

AND this object's actions include all of the specified permission's actions.

Special case: if the specified permission was constructed with "*" filter, then this method returns true if this object's filter is "*" and this object's actions include all of the specified permission's actions

Parameters:
p The permission to interrogate.
Returns:
true if the specified permission is implied by this object; false otherwise.
Exceptions:
RuntimeException if specified permission was not constructed with a bundle or "*"

Definition at line 452 of file AdminPermission.java.

References org.osgi.framework.AdminPermission.actionMask, org.osgi.framework.AdminPermission.bundle, and org.osgi.framework.AdminPermission.equals().

PermissionCollection org.osgi.framework.AdminPermission.newPermissionCollection (  ) 

Returns a new PermissionCollection object suitable for storing AdminPermissions.

Returns:
A new PermissionCollection object.

Definition at line 477 of file AdminPermission.java.


Member Data Documentation

final String org.osgi.framework.AdminPermission.CLASS = "class" [static]

The action string class (Value is "class").

Since:
1.3

Definition at line 118 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.EXECUTE = "execute" [static]

The action string execute (Value is "execute").

Since:
1.3

Definition at line 123 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.EXTENSIONLIFECYCLE = "extensionLifecycle" [static]

The action string extensionLifecycle (Value is "extensionLifecycle").

Since:
1.3

Definition at line 129 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.LIFECYCLE = "lifecycle" [static]

The action string lifecycle (Value is "lifecycle").

Since:
1.3

Definition at line 134 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.LISTENER = "listener" [static]

The action string listener (Value is "listener").

Since:
1.3

Definition at line 139 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.METADATA = "metadata" [static]

The action string metadata (Value is "metadata").

Since:
1.3

Definition at line 144 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.RESOLVE = "resolve" [static]

The action string resolve (Value is "resolve").

Since:
1.3

Definition at line 149 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.RESOURCE = "resource" [static]

The action string resource (Value is "resource").

Since:
1.3

Definition at line 154 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().

final String org.osgi.framework.AdminPermission.STARTLEVEL = "startlevel" [static]

The action string startlevel (Value is "startlevel").

Since:
1.3

Definition at line 159 of file AdminPermission.java.

Referenced by org.osgi.framework.AdminPermission.getActions().


The documentation for this class was generated from the following file:
Generated on Mon Jan 11 21:19:23 2010 for OpenMobileIS by  doxygen 1.5.4