org.osgi.core 6.0.0 · org.osgi.framework.AdminPermission

A bundle'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
                   BundleStartLevel.setStartLevel
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            FrameworkWiring.refreshBundles
                   FrameworkWiring.resolveBundles
resource           Bundle.getResource
                   Bundle.getResources
                   Bundle.getEntry
                   Bundle.getEntryPaths
                   Bundle.findEntries
                   Bundle resource/entry URL creation
startlevel         FrameworkStartLevel.setStartLevel
                   FrameworkStartLevel.setInitialBundleStartLevel
context            Bundle.getBundleContext
weave              WovenClass.getBytes
                   WovenClass.setBytes
                   WovenClass.getDynamicImports for modification

The special action "*" will represent all actions. The resolve action is implied by the class, execute and resource actions.

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

signer - A Distinguished Name chain used to sign a bundle. Wildcards in a DN are not matched according to the filter string rules, but according to the rules defined for a DN chain.
location - The location of a bundle.
id - The bundle ID of the designated bundle.
name - The symbolic name of a bundle.

Filter attribute names are processed in a case sensitive manner.

Field Summary

Modifier and Type	Field and Description
private static final int	ACTION_ALL
private static final int	ACTION_CLASS
private static final int	ACTION_CONTEXT
private static final int	ACTION_EXECUTE
private static final int	ACTION_EXTENSIONLIFECYCLE
private static final int	ACTION_LIFECYCLE
private static final int	ACTION_LISTENER
pack-priv transient int	action_mask The actions mask.
private static final int	ACTION_METADATA
pack-priv static final int	ACTION_NONE
private static final int	ACTION_RESOLVE
private static final int	ACTION_RESOURCE
private static final int	ACTION_STARTLEVEL
private static final int	ACTION_WEAVE
private volatile String	actions The actions in canonical form.
pack-priv final transient Bundle	bundle The bundle governed by this AdminPermission - only used if filter == null
public static final String	CLASS The action string `class`.
public static final String	CONTEXT The action string `context`.
public static final String	EXECUTE The action string `execute`.
public static final String	EXTENSIONLIFECYCLE The action string `extensionLifecycle`.
pack-priv transient Filter	filter If this AdminPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.
public static final String	LIFECYCLE The action string `lifecycle`.
public static final String	LISTENER The action string `listener`.
public static final String	METADATA The action string `metadata`.
private transient volatile Map<String, Object>	properties This map holds the properties of the permission, used to match a filter in implies.
private static final ThreadLocal<Bundle>	recurse ThreadLocal used to determine if we have recursively called getProperties.
public static final String	RESOLVE The action string `resolve`.
public static final String	RESOURCE The action string `resource`.
pack-priv static final long	serialVersionUID Hides java.security.BasicPermission.serialVersionUID.
public static final String	STARTLEVEL The action string `startlevel`.
public static final String	WEAVE The action string `weave`.

Constructor Summary

Access	Constructor and Description
public	AdminPermission() Creates a new `AdminPermission` object that matches all bundles and has all actions.
public	AdminPermission(String A filter expression that can use signer, location, id, and name keys. A value of "" or `null` matches all bundle. Filter attribute names are processed in a case sensitive manner. filter, String `class`, `execute`, `extensionLifecycle` , `lifecycle`, `listener`, `metadata`, `resolve` , `resource`, `startlevel`, `context` or `weave`. A value of "" or `null` indicates all actions. actions) Create a new AdminPermission.
public	AdminPermission(Bundle A bundle. bundle, String `class`, `execute`, `extensionLifecycle` , `lifecycle`, `listener`, `metadata`, `resolve` , `resource`, `startlevel`, `context`, `weave`. A value of "*" or `null` indicates all actions. actions) Creates a new requested `AdminPermission` object to be used by the code that must perform `checkPermission`.
pack-priv	AdminPermission(Filter name filter or `null` for wildcard. filter, int action mask mask) Package private constructor used by AdminPermissionCollection.

Method Summary

Modifier and Type	Method and Description
private static String	Returns: permission name. createName(Bundle Bundle to use to create permission name. bundle) Create a permission name from a Bundle
public boolean	Returns: `true` if `obj` is equivalent to this `AdminPermission`; `false` otherwise. equals(Object The object being compared for equality with this object. obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `AdminPermission` objects.
public String	Returns: Canonical string representation of the `AdminPermission` actions. getActions() Overrides java.security.BasicPermission.getActions. Returns the canonical string representation of the `AdminPermission` actions.
private Map<String, Object>	Returns: a map of properties for this bundle getProperties() Called by `implies0` on an AdminPermission which was constructed with a Bundle.
public int	Returns: Hash code value for this object. hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object.
public boolean	Returns: `true` if the specified permission is implied by this object; `false` otherwise. implies(Permission The requested permission. p) Overrides java.security.BasicPermission.implies. Determines if the specified permission is implied by this object.
pack-priv boolean	Returns: `true` if the specified permission is implied by this object; `false` otherwise. implies0(AdminPermission The requested AdminPermision which has already be validated as a proper argument. The requested AdminPermission must not have a filter expression. requested, int The effective actions with which to start. effective) Internal implies method.
public PermissionCollection	Returns: A new `PermissionCollection` object. newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `AdminPermission`s.
private static int	Returns: action mask. parseActions(String Action string. actions) Parse action string into action mask.
private static Filter	Returns: a Filter for this bundle. If the specified filterString is `null` or equals "*", then `null` is returned to indicate a wildcard. parseFilter(String The filter string to parse. filterString) Parse filter string into a Filter object.
private synchronized void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read s) Hides java.security.BasicPermission.readObject. readObject is called to restore the state of this permission from a stream.
private void	setTransients(Filter Permission's filter or `null` for wildcard. filter, int action mask mask) Called by constructors and when deserialized.
private synchronized void	writeObject(ObjectOutputStream s) WriteObject is called to save the state of this permission object to a stream.

Field Detail

ACTION_ALL	back to summary
private static final int ACTION_ALL

ACTION_CLASS	back to summary
private static final int ACTION_CLASS

ACTION_CONTEXT	back to summary
private static final int ACTION_CONTEXT

ACTION_EXECUTE	back to summary
private static final int ACTION_EXECUTE

ACTION_EXTENSIONLIFECYCLE	back to summary
private static final int ACTION_EXTENSIONLIFECYCLE

ACTION_LIFECYCLE	back to summary
private static final int ACTION_LIFECYCLE

ACTION_LISTENER	back to summary
private static final int ACTION_LISTENER

action_mask	back to summary
pack-priv transient int action_mask The actions mask.

ACTION_METADATA	back to summary
private static final int ACTION_METADATA

ACTION_NONE	back to summary
pack-priv static final int ACTION_NONE

ACTION_RESOLVE	back to summary
private static final int ACTION_RESOLVE

ACTION_RESOURCE	back to summary
private static final int ACTION_RESOURCE

ACTION_STARTLEVEL	back to summary
private static final int ACTION_STARTLEVEL

ACTION_WEAVE	back to summary
private static final int ACTION_WEAVE

actions	back to summary
private volatile String actions The actions in canonical form.

bundle	back to summary
pack-priv final transient Bundle bundle The bundle governed by this AdminPermission - only used if filter == null

CLASS back to summary

CLASS	back to summary
public static final String CLASS The action string `class`. The `class` action implies the `resolve` action. Since 1.3

public static final String CLASS

The action string class. The class action implies the resolve action.

Since: 1.3

CONTEXT back to summary

CONTEXT	back to summary
public static final String CONTEXT The action string `context`. Since 1.4

public static final String CONTEXT

The action string context.

Since: 1.4

EXECUTE back to summary

EXECUTE	back to summary
public static final String EXECUTE The action string `execute`. The `execute` action implies the `resolve` action. Since 1.3

public static final String EXECUTE

The action string execute. The execute action implies the resolve action.

Since: 1.3

EXTENSIONLIFECYCLE back to summary

EXTENSIONLIFECYCLE	back to summary
public static final String EXTENSIONLIFECYCLE The action string `extensionLifecycle`. Since 1.3

public static final String EXTENSIONLIFECYCLE

The action string extensionLifecycle.

Since: 1.3

filter	back to summary
pack-priv transient Filter filter If this AdminPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.

LIFECYCLE back to summary

LIFECYCLE	back to summary
public static final String LIFECYCLE The action string `lifecycle`. Since 1.3

public static final String LIFECYCLE

The action string lifecycle.

Since: 1.3

LISTENER back to summary

LISTENER	back to summary
public static final String LISTENER The action string `listener`. Since 1.3

public static final String LISTENER

The action string listener.

Since: 1.3

METADATA back to summary

public static final String METADATA

The action string metadata.

Since: 1.3

properties	back to summary
private transient volatile Map<String, Object> properties This map holds the properties of the permission, used to match a filter in implies. This is not initialized until necessary, and then cached in this object.

recurse	back to summary
private static final ThreadLocal<Bundle> recurse ThreadLocal used to determine if we have recursively called getProperties.

RESOLVE back to summary

RESOLVE	back to summary
public static final String RESOLVE The action string `resolve`. The `resolve` action is implied by the `class`, `execute` and `resource` actions. Since 1.3

public static final String RESOLVE

The action string resolve. The resolve action is implied by the class, execute and resource actions.

Since: 1.3

RESOURCE back to summary

RESOURCE	back to summary
public static final String RESOURCE The action string `resource`. The `resource` action implies the `resolve` action. Since 1.3

public static final String RESOURCE

The action string resource. The resource action implies the resolve action.

Since: 1.3

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

STARTLEVEL back to summary

STARTLEVEL	back to summary
public static final String STARTLEVEL The action string `startlevel`. Since 1.3

public static final String STARTLEVEL

The action string startlevel.

Since: 1.3

WEAVE back to summary

WEAVE	back to summary
public static final String WEAVE The action string `weave`. Since 1.6

public static final String WEAVE

The action string weave.

Since: 1.6

Constructor Detail

AdminPermission	back to summary
public AdminPermission() Creates a new `AdminPermission` object that matches all bundles and has all actions. Equivalent to AdminPermission("","");

AdminPermission back to summary

AdminPermission	back to summary
public 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:String A filter expression that can use signer, location, id, and name keys. A value of "" or `null` matches all bundle. Filter attribute names are processed in a case sensitive manner. actions:String `class`, `execute`, `extensionLifecycle` , `lifecycle`, `listener`, `metadata`, `resolve` , `resource`, `startlevel`, `context` or `weave`. A value of "" or `null` indicates all actions. Exceptions IllegalArgumentException: If the filter has an invalid syntax.

public 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:String: A filter expression that can use signer, location, id, and name keys. A value of "*" or null matches all bundle. Filter attribute names are processed in a case sensitive manner.
actions:String: class, execute, extensionLifecycle , lifecycle, listener, metadata, resolve , resource, startlevel, context or weave. A value of "*" or null indicates all actions.

Exceptions

IllegalArgumentException:: If the filter has an invalid syntax.

AdminPermission back to summary

AdminPermission	back to summary
public AdminPermission(Bundle bundle, String actions) Creates a new requested `AdminPermission` object to be used by the code that must perform `checkPermission`. `AdminPermission` objects created with this constructor cannot be added to an `AdminPermission` permission collection. Parameters bundle:Bundle A bundle. actions:String `class`, `execute`, `extensionLifecycle` , `lifecycle`, `listener`, `metadata`, `resolve` , `resource`, `startlevel`, `context`, `weave`. A value of "*" or `null` indicates all actions. Since 1.3

public AdminPermission(Bundle bundle, String actions)

Creates a new requested AdminPermission object to be used by the code that must perform checkPermission. AdminPermission objects created with this constructor cannot be added to an AdminPermission permission collection.

Parameters

bundle:Bundle: A bundle.
actions:String: class, execute, extensionLifecycle , lifecycle, listener, metadata, resolve , resource, startlevel, context, weave. A value of "*" or null indicates all actions.

Since

1.3

AdminPermission back to summary

AdminPermission	back to summary
pack-priv AdminPermission(Filter filter, int mask) Package private constructor used by AdminPermissionCollection. Parameters filter:Filter name filter or `null` for wildcard. mask:int action mask

pack-priv AdminPermission(Filter filter, int mask)

Package private constructor used by AdminPermissionCollection.

Parameters

filter:Filter: name filter or null for wildcard.
mask:int: action mask

Method Detail

createName	back to summary
private static String createName(Bundle bundle) Create a permission name from a Bundle Parameters bundle:Bundle Bundle to use to create permission name. Returns:String permission name.

createName

back to summary

private static String createName(Bundle bundle)

Create a permission name from a Bundle

Parameters

bundle:Bundle: Bundle to use to create permission name.

Returns:String

permission name.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `AdminPermission` objects. Parameters obj:Object The object being compared for equality with this object. Returns:boolean `true` if `obj` is equivalent to this `AdminPermission`; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

Determines the equality of two AdminPermission objects.

Parameters

obj:Object: The object being compared for equality with this object.

Returns:boolean

true if obj is equivalent to this AdminPermission; false otherwise.

Annotations

@Override

getActions back to summary

getActions	back to summary
public String getActions() Overrides java.security.BasicPermission.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`, `context`, `weave`. Returns:String Canonical string representation of the `AdminPermission` actions. Annotations @Override

public String getActions()

Overrides java.security.BasicPermission.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, context, weave.

Returns:String

Canonical string representation of the AdminPermission actions.

Annotations

@Override

getProperties back to summary

getProperties	back to summary
private Map<String, Object> getProperties() Called by `implies0` on an AdminPermission which was constructed with a Bundle. This method loads a map with the filter-matchable properties of this bundle. The map is cached so this lookup only happens once. This method should only be called on an AdminPermission which was constructed with a bundle Returns:Map<String, Object> a map of properties for this bundle

private Map<String, Object> getProperties()

Called by implies0 on an AdminPermission which was constructed with a Bundle. This method loads a map with the filter-matchable properties of this bundle. The map is cached so this lookup only happens once. This method should only be called on an AdminPermission which was constructed with a bundle

Returns:Map<String, Object>: a map of properties for this bundle

hashCode	back to summary
public int hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object. Returns:int Hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.security.BasicPermission.hashCode.

Returns the hash code value for this object.

Returns:int

Hash code value for this object.

Annotations

@Override

implies back to summary

implies	back to summary
public boolean implies(Permission p) Overrides java.security.BasicPermission.implies. 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 this object's filter matches the specified permission's bundle ID, bundle symbolic name, bundle location and bundle signer distinguished name chain OR this object's filter is "" 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:Permission The requested permission. Returns:boolean `true` if the specified permission is implied by this object; `false` otherwise. Annotations @Override

public boolean implies(Permission p)

Overrides java.security.BasicPermission.implies.

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

this object's filter matches the specified permission's bundle ID, bundle symbolic name, bundle location and bundle signer distinguished name chain OR
this object's filter is "*"

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:Permission: The requested permission.

Returns:boolean

true if the specified permission is implied by this object; false otherwise.

Annotations

@Override

implies0 back to summary

implies0	back to summary
pack-priv boolean implies0(AdminPermission requested, int effective) Internal implies method. Used by the implies and the permission collection implies methods. Parameters requested:AdminPermission The requested AdminPermision which has already be validated as a proper argument. The requested AdminPermission must not have a filter expression. effective:int The effective actions with which to start. Returns:boolean `true` if the specified permission is implied by this object; `false` otherwise.

pack-priv boolean implies0(AdminPermission requested, int effective)

Internal implies method. Used by the implies and the permission collection implies methods.

Parameters

requested:AdminPermission: The requested AdminPermision which has already be validated as a proper argument. The requested AdminPermission must not have a filter expression.
effective:int: The effective actions with which to start.

Returns:boolean

true if the specified permission is implied by this object; false otherwise.

newPermissionCollection back to summary

newPermissionCollection	back to summary
public PermissionCollection newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `AdminPermission`s. Returns:PermissionCollection A new `PermissionCollection` object. Annotations @Override

public PermissionCollection newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection object suitable for storing AdminPermissions.

Returns:PermissionCollection

A new PermissionCollection object.

Annotations

@Override

parseActions	back to summary
private static int parseActions(String actions) Parse action string into action mask. Parameters actions:String Action string. Returns:int action mask.

parseActions

back to summary

private static int parseActions(String actions)

Parse action string into action mask.

Parameters

actions:String: Action string.

Returns:int

action mask.

parseFilter back to summary

parseFilter	back to summary
private static Filter parseFilter(String filterString) Parse filter string into a Filter object. Parameters filterString:String The filter string to parse. Returns:Filter a Filter for this bundle. If the specified filterString is `null` or equals "*", then `null` is returned to indicate a wildcard. Exceptions IllegalArgumentException: If the filter syntax is invalid.

private static Filter parseFilter(String filterString)

Parse filter string into a Filter object.

Parameters

filterString:String: The filter string to parse.

Returns:Filter

a Filter for this bundle. If the specified filterString is null or equals "*", then null is returned to indicate a wildcard.

Exceptions

IllegalArgumentException:: If the filter syntax is invalid.

readObject back to summary

readObject	back to summary
private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Hides java.security.BasicPermission.readObject. readObject is called to restore the state of this permission from a stream. Parameters s:ObjectInputStream Doc from java.security.BasicPermission.readObject. the `ObjectInputStream` from which data is read Exceptions IOException: Doc from java.security.BasicPermission.readObject. if an I/O error occurs ClassNotFoundException: Doc from java.security.BasicPermission.readObject. if a serialized class cannot be loaded

private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Hides java.security.BasicPermission.readObject.

readObject is called to restore the state of this permission from a stream.

Parameters

s:ObjectInputStream

Doc from java.security.BasicPermission.readObject.

the ObjectInputStream from which data is read

Exceptions

IOException:

Doc from java.security.BasicPermission.readObject.

if an I/O error occurs

ClassNotFoundException:

Doc from java.security.BasicPermission.readObject.

if a serialized class cannot be loaded

setTransients back to summary

setTransients	back to summary
private void setTransients(Filter filter, int mask) Called by constructors and when deserialized. Parameters filter:Filter Permission's filter or `null` for wildcard. mask:int action mask

private void setTransients(Filter filter, int mask)

Called by constructors and when deserialized.

Parameters

filter:Filter: Permission's filter or null for wildcard.
mask:int: action mask

writeObject	back to summary
private synchronized void writeObject(ObjectOutputStream s) throws IOException WriteObject is called to save the state of this permission object to a stream. The actions are serialized, and the superclass takes care of the name.

public final Class AdminPermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail