OSGi 8.1.0 · org.osgi.framework.BundlePermission · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final int	ACTION_ALL
private static final int	ACTION_FRAGMENT
private static final int	ACTION_HOST
private transient int	action_mask The actions mask.
pack-priv static final int	ACTION_NONE
private static final int	ACTION_PROVIDE
private static final int	ACTION_REQUIRE
private volatile String	actions The actions in canonical form.
public static final String	FRAGMENT The action string `fragment`.
public static final String	HOST The action string `host`.
public static final String	PROVIDE The action string `provide`.
public static final String	REQUIRE The action string `require`.
private static final long	serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	BundlePermission(String The bundle symbolic name. symbolicName, String `provide`,`require`, `host`, `fragment` (canonical order). actions) Defines the authority to provide and/or require and or specify a host fragment symbolic name within the OSGi environment.
pack-priv	BundlePermission(String the bundle symbolic name symbolicName, int the action mask mask) Package private constructor used by BundlePermissionCollection.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `obj` is a `BundlePermission`, and has the same bundle symbolic name and actions as this `BundlePermission` object; `false` otherwise. equals(Object The object to test for equality with this `BundlePermission` object. obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `BundlePermission` objects.
public String	Returns: Canonical string representation of the `BundlePermission` actions. getActions() Overrides java.security.BasicPermission.getActions. Returns the canonical string representation of the `BundlePermission` actions.
pack-priv synchronized int	Returns: Current action mask. getActionsMask() Returns the current action mask.
public int	Returns: A 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 `BundlePermission` action 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.
public PermissionCollection	Returns: A new `PermissionCollection` object. newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `BundlePermission` objects.
private static int	Returns: action mask. parseActions(String Action string. actions) Parse action string into action mask.
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 the BundlePermission from a stream.
private synchronized void	setTransients(int mask) Called by constructors and when deserialized.
private synchronized void	writeObject(ObjectOutputStream s) WriteObject is called to save the state of the `BundlePermission` object to a stream.

Field Detail

ACTION_ALL	back to summary
private static final int ACTION_ALL

ACTION_FRAGMENT	back to summary
private static final int ACTION_FRAGMENT

ACTION_HOST	back to summary
private static final int ACTION_HOST

action_mask	back to summary
private transient int action_mask The actions mask.

ACTION_NONE	back to summary
pack-priv static final int ACTION_NONE

ACTION_PROVIDE	back to summary
private static final int ACTION_PROVIDE

ACTION_REQUIRE	back to summary
private static final int ACTION_REQUIRE

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

FRAGMENT	back to summary
public static final String FRAGMENT The action string `fragment`.

HOST	back to summary
public static final String HOST The action string `host`.

PROVIDE	back to summary
public static final String PROVIDE The action string `provide`. The `provide` action implies the `require` action.

REQUIRE	back to summary
public static final String REQUIRE The action string `require`. The `require` action is implied by the `provide` action.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Constructor Detail

BundlePermission back to summary

BundlePermission	back to summary
public BundlePermission(String symbolicName, String actions) Defines the authority to provide and/or require and or specify a host fragment symbolic name within the OSGi environment. Bundle Permissions are granted over all possible versions of a bundle. A bundle that needs to provide a bundle must have the appropriate `BundlePermission` for the symbolic name; a bundle that requires a bundle must have the appropriate `BundlePermssion` for that symbolic name; a bundle that specifies a fragment host must have the appropriate `BundlePermission` for that symbolic name. Parameters symbolicName:String The bundle symbolic name. actions:String `provide`,`require`, `host`, `fragment` (canonical order).

public BundlePermission(String symbolicName, String actions)

Defines the authority to provide and/or require and or specify a host fragment symbolic name within the OSGi environment.

Bundle Permissions are granted over all possible versions of a bundle. A bundle that needs to provide a bundle must have the appropriate BundlePermission for the symbolic name; a bundle that requires a bundle must have the appropriate BundlePermssion for that symbolic name; a bundle that specifies a fragment host must have the appropriate BundlePermission for that symbolic name.

Parameters

symbolicName:String: The bundle symbolic name.
actions:String: provide,require, host, fragment (canonical order).

BundlePermission	back to summary
pack-priv BundlePermission(String symbolicName, int mask) Package private constructor used by BundlePermissionCollection. Parameters symbolicName:String the bundle symbolic name mask:int the action mask

BundlePermission

back to summary

pack-priv BundlePermission(String symbolicName, int mask)

Package private constructor used by BundlePermissionCollection.

Parameters

symbolicName:String: the bundle symbolic name
mask:int: the action mask

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `BundlePermission` objects. This method checks that specified bundle has the same bundle symbolic name and `BundlePermission` actions as this `BundlePermission` object. Parameters obj:Object The object to test for equality with this `BundlePermission` object. Returns:boolean `true` if `obj` is a `BundlePermission`, and has the same bundle symbolic name and actions as this `BundlePermission` object; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

Determines the equality of two BundlePermission objects. This method checks that specified bundle has the same bundle symbolic name and BundlePermission actions as this BundlePermission object.

Parameters

obj:Object: The object to test for equality with this BundlePermission object.

Returns:boolean

true if obj is a BundlePermission, and has the same bundle symbolic name and actions as this BundlePermission object; 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 `BundlePermission` actions. Always returns present `BundlePermission` actions in the following order: `provide`, `require`, `host`, `fragment`. Returns:String Canonical string representation of the `BundlePermission` actions. Annotations @Override

public String getActions()

Overrides java.security.BasicPermission.getActions.

Returns the canonical string representation of the BundlePermission actions.

Always returns present BundlePermission actions in the following order: provide, require, host, fragment.

Returns:String

Canonical string representation of the BundlePermission actions.

Annotations

@Override

getActionsMask	back to summary
pack-priv synchronized int getActionsMask() Returns the current action mask. Used by the BundlePermissionCollection class. Returns:int Current action mask.

getActionsMask

back to summary

pack-priv synchronized int getActionsMask()

Returns the current action mask.

Used by the BundlePermissionCollection class.

Returns:int: Current action mask.

hashCode	back to summary
public int hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object. Returns:int A 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

A 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 checks that the symbolic name of the target is implied by the symbolic name of this object. The list of `BundlePermission` actions must either match or allow for the list of the target object to imply the target `BundlePermission` action. The permission to provide a bundle implies the permission to require the named symbolic name. x.y.,"provide" -> x.y.z,"provide" is true ,"require" -> x.y, "require" is true *,"provide" -> x.y, "require" is true x.y,"provide" -> x.y.z, "provide" is false Parameters p:Permission The requested permission. Returns:boolean `true` if the specified `BundlePermission` action 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 checks that the symbolic name of the target is implied by the symbolic name of this object. The list of BundlePermission actions must either match or allow for the list of the target object to imply the target BundlePermission action.

The permission to provide a bundle implies the permission to require the named symbolic name.

      x.y.*,"provide" -> x.y.z,"provide" is true
      *,"require" -> x.y, "require"      is true
      *,"provide" -> x.y, "require"      is true
      x.y,"provide" -> x.y.z, "provide"  is false

Parameters

p:Permission: The requested permission.

Returns:boolean

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

Annotations

@Override

newPermissionCollection back to summary

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

public PermissionCollection newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection object suitable for storing BundlePermission objects.

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.

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 the BundlePermission 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 the BundlePermission 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
private synchronized void setTransients(int mask) Called by constructors and when deserialized.

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

public final Class BundlePermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail