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

Field Summary

Modifier and Type	Field and Description
private static final int	ACTION_ALL
private static final int	ACTION_EXPORT
private static final int	ACTION_IMPORT
pack-priv transient int	action_mask The actions mask.
pack-priv static final int	ACTION_NONE
private volatile String	actions The actions in canonical form.
pack-priv final transient Bundle	bundle The bundle used by this PackagePermission.
public static final String	EXPORT Deprecated As of 1.5. Use `exportonly` instead. The action string `export`.
public static final String	EXPORTONLY The action string `exportonly`.
pack-priv transient Filter	filter If this PackagePermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.
public static final String	IMPORT The action string `import`.
private transient volatile Map<String, Object>	properties This map holds the properties of the permission, used to match a filter in implies.
pack-priv static final long	serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	PackagePermission(String Package name or filter expression. A filter expression can only be specified if the specified action is `import`. name, String `exportonly`,`import` (canonical order). actions) Creates a new `PackagePermission` object.
public	PackagePermission(String The name of the requested package to import. name, Bundle The bundle exporting the requested package. exportingBundle, String The action `import`. actions) Creates a new requested `PackagePermission` object to be used by code that must perform `checkPermission` for the `import` action.
pack-priv	PackagePermission(String package name name, int action mask mask) Package private constructor used by PackagePermissionCollection.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `obj` is a `PackagePermission`, and has the same package name and actions as this `PackagePermission` object; `false` otherwise. equals(Object The object to test for equality with this `PackagePermission` object. obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `PackagePermission` objects.
public String	Returns: Canonical string representation of the `PackagePermission` actions. getActions() Overrides java.security.BasicPermission.getActions. Returns the canonical string representation of the `PackagePermission` actions.
private Map<String, Object>	Returns: a map of properties for this permission. getProperties() Called by `PackagePermission#implies(Permission)`.
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 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(PackagePermission The requested PackagePermission which has already be validated as a proper argument. The requested PackagePermission 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 `PackagePermission` objects.
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 not a filter expression, then `null` is returned. 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(String name, 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_EXPORT	back to summary
private static final int ACTION_EXPORT

ACTION_IMPORT	back to summary
private static final int ACTION_IMPORT

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

ACTION_NONE	back to summary
pack-priv static final int ACTION_NONE

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 used by this PackagePermission.

EXPORT	back to summary
public static final String EXPORT Deprecated As of 1.5. Use `exportonly` instead. The action string `export`. The `export` action implies the `import` action.

EXPORTONLY back to summary

EXPORTONLY	back to summary
public static final String EXPORTONLY The action string `exportonly`. The `exportonly` action does not imply the `import` action. Since 1.5

public static final String EXPORTONLY

The action string exportonly. The exportonly action does not imply the import action.

Since: 1.5

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

IMPORT	back to summary
public static final String IMPORT The action string `import`.

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.

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

Constructor Detail

PackagePermission back to summary

PackagePermission	back to summary
public PackagePermission(String name, String actions) Creates a new `PackagePermission` object. The name is specified as a normal Java package name: a dot-separated string. Wildcards may be used. name ::= <package name> \| <package name ending in "."> \| Examples: org.osgi.service.http javax.servlet.* * For the `import` action, the name can also be a filter expression. The filter gives access to the following attributes: signer - A Distinguished Name chain used to sign the exporting 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 the exporting bundle. id - The bundle ID of the exporting bundle. name - The symbolic name of the exporting bundle. package.name - The name of the requested package. Filter attribute names are processed in a case sensitive manner. Package Permissions are granted over all possible versions of a package. A bundle that needs to export a package must have the appropriate `PackagePermission` for that package; similarly, a bundle that needs to import a package must have the appropriate `PackagePermssion` for that package. Permission is granted for both classes and resources. Parameters name:String Package name or filter expression. A filter expression can only be specified if the specified action is `import`. actions:String `exportonly`,`import` (canonical order). Exceptions IllegalArgumentException: If the specified name is a filter expression and either the specified action is not `import` or the filter has an invalid syntax.

public PackagePermission(String name, String actions)

Creates a new PackagePermission object.

The name is specified as a normal Java package name: a dot-separated string. Wildcards may be used.

name ::= <package name> | <package name ending in ".*"> | *

Examples:

org.osgi.service.http
javax.servlet.*
*

For the import action, the name can also be a filter expression. The filter gives access to the following attributes:

signer - A Distinguished Name chain used to sign the exporting 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 the exporting bundle.
id - The bundle ID of the exporting bundle.
name - The symbolic name of the exporting bundle.
package.name - The name of the requested package.

Filter attribute names are processed in a case sensitive manner.

Package Permissions are granted over all possible versions of a package. A bundle that needs to export a package must have the appropriate PackagePermission for that package; similarly, a bundle that needs to import a package must have the appropriate PackagePermssion for that package.

Permission is granted for both classes and resources.

Parameters

name:String: Package name or filter expression. A filter expression can only be specified if the specified action is import.
actions:String: exportonly,import (canonical order).

Exceptions

IllegalArgumentException:: If the specified name is a filter expression and either the specified action is not import or the filter has an invalid syntax.

PackagePermission back to summary

PackagePermission	back to summary
public PackagePermission(String name, Bundle exportingBundle, String actions) Creates a new requested `PackagePermission` object to be used by code that must perform `checkPermission` for the `import` action. `PackagePermission` objects created with this constructor cannot be added to a `PackagePermission` permission collection. Parameters name:String The name of the requested package to import. exportingBundle:Bundle The bundle exporting the requested package. actions:String The action `import`. Exceptions IllegalArgumentException: If the specified action is not `import` or the name is a filter expression. Since 1.5

public PackagePermission(String name, Bundle exportingBundle, String actions)

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

Parameters

name:String: The name of the requested package to import.
exportingBundle:Bundle: The bundle exporting the requested package.
actions:String: The action import.

Exceptions

IllegalArgumentException:: If the specified action is not import or the name is a filter expression.

Since

1.5

PackagePermission	back to summary
pack-priv PackagePermission(String name, int mask) Package private constructor used by PackagePermissionCollection. Parameters name:String package name mask:int action mask

PackagePermission

back to summary

pack-priv PackagePermission(String name, int mask)

Package private constructor used by PackagePermissionCollection.

Parameters

name:String: package name
mask:int: 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 `PackagePermission` objects. This method checks that specified package has the same package name and `PackagePermission` actions as this `PackagePermission` object. Parameters obj:Object The object to test for equality with this `PackagePermission` object. Returns:boolean `true` if `obj` is a `PackagePermission`, and has the same package name and actions as this `PackagePermission` object; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

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

Parameters

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

Returns:boolean

true if obj is a PackagePermission, and has the same package name and actions as this PackagePermission 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 `PackagePermission` actions. Always returns present `PackagePermission` actions in the following order: `EXPORTONLY`,`IMPORT`. Returns:String Canonical string representation of the `PackagePermission` actions. Annotations @Override

public String getActions()

Overrides java.security.BasicPermission.getActions.

Returns the canonical string representation of the PackagePermission actions.

Always returns present PackagePermission actions in the following order: EXPORTONLY,IMPORT.

Returns:String

Canonical string representation of the PackagePermission actions.

Annotations

@Override

getProperties back to summary

getProperties	back to summary
private Map<String, Object> getProperties() Called by `PackagePermission#implies(Permission)`. This method is only called on a requested permission which cannot have a filter set. Returns:Map<String, Object> a map of properties for this permission.

private Map<String, Object> getProperties()

Called by PackagePermission#implies(Permission). This method is only called on a requested permission which cannot have a filter set.

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

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 package name of the target is implied by the package name of this object. The list of `PackagePermission` actions must either match or allow for the list of the target object to imply the target `PackagePermission` action. The permission to export a package implies the permission to import the named package. x.y.,"export" -> x.y.z,"export" is true ,"import" -> x.y, "import" is true *,"export" -> x.y, "import" is true x.y,"export" -> x.y.z, "export" is false 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 checks that the package name of the target is implied by the package name of this object. The list of PackagePermission actions must either match or allow for the list of the target object to imply the target PackagePermission action.

The permission to export a package implies the permission to import the named package.

x.y.*,"export" -> x.y.z,"export" is true
*,"import" -> x.y, "import"      is true
*,"export" -> x.y, "import"      is true
x.y,"export" -> x.y.z, "export"  is false

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(PackagePermission requested, int effective) Internal implies method. Used by the implies and the permission collection implies methods. Parameters requested:PackagePermission The requested PackagePermission which has already be validated as a proper argument. The requested PackagePermission 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(PackagePermission requested, int effective)

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

Parameters

requested:PackagePermission: The requested PackagePermission which has already be validated as a proper argument. The requested PackagePermission 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 `PackagePermission` 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 PackagePermission 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.

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 not a filter expression, then `null` is returned. 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 not a filter expression, then null is returned.

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
private void setTransients(String name, int mask) Called by constructors and when deserialized. Parameters mask:int action mask

setTransients

back to summary

private void setTransients(String name, int mask)

Called by constructors and when deserialized.

Parameters

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 PackagePermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail