Class PackagePermission
- All Implemented Interfaces:
Serializable
,Guard
A package is a dot-separated string that defines a fully qualified Java package.
For example:
org.osgi.service.http
PackagePermission
has three actions: exportonly
,
import
and export
. The export
action, which is
deprecated, implies the import
action.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private static final int
private static final int
(package private) int
The actions mask.(package private) static final int
private String
The actions in canonical form.(package private) final Bundle
The bundle used by this PackagePermission.static final String
Deprecated.As of 1.5.static final String
The action stringexportonly
.(package private) Filter
If this PackagePermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.static final String
The action stringimport
.This map holds the properties of the permission, used to match a filter in implies.(package private) static final long
-
Constructor Summary
ConstructorsConstructorDescriptionPackagePermission
(String name, int mask) Package private constructor used by PackagePermissionCollection.PackagePermission
(String name, String actions) Creates a newPackagePermission
object.PackagePermission
(String name, Bundle exportingBundle, String actions) Creates a new requestedPackagePermission
object to be used by code that must performcheckPermission
for theimport
action. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines the equality of twoPackagePermission
objects.Returns the canonical string representation of thePackagePermission
actions.Called byimplies(Permission)
.int
hashCode()
Returns the hash code value for this object.boolean
Determines if the specified permission is implied by this object.(package private) boolean
implies0
(PackagePermission requested, int effective) Internal implies method.Returns a newPermissionCollection
object suitable for storingPackagePermission
objects.private static int
parseActions
(String actions) Parse action string into action mask.private static Filter
parseFilter
(String filterString) Parse filter string into a Filter object.private void
readObject is called to restore the state of this permission from a stream.private void
setTransients
(String name, int mask) Called by constructors and when deserialized.private void
WriteObject is called to save the state of this permission object to a stream.Methods inherited from class java.security.Permission
checkGuard, getName, toString
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
EXPORT
Deprecated.As of 1.5. Useexportonly
instead.The action stringexport
. Theexport
action implies theimport
action.- See Also:
-
EXPORTONLY
The action stringexportonly
. Theexportonly
action does not imply theimport
action.- Since:
- 1.5
- See Also:
-
IMPORT
The action stringimport
.- See Also:
-
ACTION_EXPORT
private static final int ACTION_EXPORT- See Also:
-
ACTION_IMPORT
private static final int ACTION_IMPORT- See Also:
-
ACTION_ALL
private static final int ACTION_ALL- See Also:
-
ACTION_NONE
static final int ACTION_NONE- See Also:
-
action_mask
transient int action_maskThe actions mask. -
actions
The actions in canonical form. -
bundle
The bundle used by this PackagePermission. -
filter
If this PackagePermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies. -
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.
-
-
Constructor Details
-
PackagePermission
Creates a newPackagePermission
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 theimport
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.
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 appropriatePackagePermssion
for that package.Permission is granted for both classes and resources.
- Parameters:
name
- Package name or filter expression. A filter expression can only be specified if the specified action isimport
.actions
-exportonly
,import
(canonical order).- Throws:
IllegalArgumentException
- If the specified name is a filter expression and either the specified action is notimport
or the filter has an invalid syntax.
-
PackagePermission
Creates a new requestedPackagePermission
object to be used by code that must performcheckPermission
for theimport
action.PackagePermission
objects created with this constructor cannot be added to aPackagePermission
permission collection.- Parameters:
name
- The name of the requested package to import.exportingBundle
- The bundle exporting the requested package.actions
- The actionimport
.- Throws:
IllegalArgumentException
- If the specified action is notimport
or the name is a filter expression.- Since:
- 1.5
-
PackagePermission
PackagePermission(String name, int mask) Package private constructor used by PackagePermissionCollection.- Parameters:
name
- package namemask
- action mask
-
-
Method Details
-
setTransients
Called by constructors and when deserialized.- Parameters:
mask
- action mask
-
parseActions
Parse action string into action mask.- Parameters:
actions
- Action string.- Returns:
- action mask.
-
parseFilter
Parse filter string into a Filter object.- Parameters:
filterString
- The filter string to parse.- Returns:
- a Filter for this bundle. If the specified filterString is not a
filter expression, then
null
is returned. - Throws:
IllegalArgumentException
- If the filter syntax is invalid.
-
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 targetPackagePermission
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
- Overrides:
implies
in classBasicPermission
- Parameters:
p
- The requested permission.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
implies0
Internal implies method. Used by the implies and the permission collection implies methods.- Parameters:
requested
- The requested PackagePermission which has already be validated as a proper argument. The requested PackagePermission must not have a filter expression.effective
- The effective actions with which to start.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
getActions
Returns the canonical string representation of thePackagePermission
actions.Always returns present
PackagePermission
actions in the following order:EXPORTONLY
,IMPORT
.- Overrides:
getActions
in classBasicPermission
- Returns:
- Canonical string representation of the
PackagePermission
actions.
-
newPermissionCollection
Returns a newPermissionCollection
object suitable for storingPackagePermission
objects.- Overrides:
newPermissionCollection
in classBasicPermission
- Returns:
- A new
PermissionCollection
object.
-
equals
Determines the equality of twoPackagePermission
objects. This method checks that specified package has the same package name andPackagePermission
actions as thisPackagePermission
object.- Overrides:
equals
in classBasicPermission
- Parameters:
obj
- The object to test for equality with thisPackagePermission
object.- Returns:
true
ifobj
is aPackagePermission
, and has the same package name and actions as thisPackagePermission
object;false
otherwise.
-
hashCode
public int hashCode()Returns the hash code value for this object.- Overrides:
hashCode
in classBasicPermission
- Returns:
- A hash code value for this object.
-
writeObject
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.- Throws:
IOException
-
readObject
readObject is called to restore the state of this permission from a stream.- Throws:
IOException
ClassNotFoundException
-
getProperties
Called byimplies(Permission)
. This method is only called on a requested permission which cannot have a filter set.- Returns:
- a map of properties for this permission.
-