public final class PackagePermission
extends java.security.BasicPermission
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.
Modifier and Type | Field and Description |
---|---|
private static int |
ACTION_ALL |
private static int |
ACTION_EXPORT |
private static int |
ACTION_IMPORT |
(package private) int |
action_mask
The actions mask.
|
(package private) static int |
ACTION_NONE |
private java.lang.String |
actions
The actions in canonical form.
|
(package private) Bundle |
bundle
The bundle used by this PackagePermission.
|
static java.lang.String |
EXPORT
Deprecated.
Since 1.5. Use
exportonly instead. |
static java.lang.String |
EXPORTONLY
The action string
exportonly . |
(package private) Filter |
filter
If this PackagePermission was constructed with a filter, this holds a
Filter matching object used to evaluate the filter in implies.
|
static java.lang.String |
IMPORT
The action string
import . |
private java.util.Map<java.lang.String,java.lang.Object> |
properties
This map holds the properties of the permission, used to match a filter
in implies.
|
(package private) static long |
serialVersionUID |
Constructor and Description |
---|
PackagePermission(java.lang.String name,
Bundle exportingBundle,
java.lang.String actions)
Creates a new requested
PackagePermission object to be used by
code that must perform checkPermission for the import
action. |
PackagePermission(java.lang.String name,
int mask)
Package private constructor used by PackagePermissionCollection.
|
PackagePermission(java.lang.String name,
java.lang.String actions)
Creates a new
PackagePermission object. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines the equality of two
PackagePermission objects. |
java.lang.String |
getActions()
Returns the canonical string representation of the
PackagePermission actions. |
private java.util.Map<java.lang.String,java.lang.Object> |
getProperties()
Called by
implies(Permission) . |
int |
hashCode()
Returns the hash code value for this object.
|
boolean |
implies(java.security.Permission p)
Determines if the specified permission is implied by this object.
|
(package private) boolean |
implies0(PackagePermission requested,
int effective)
Internal implies method.
|
java.security.PermissionCollection |
newPermissionCollection()
Returns a new
PermissionCollection object suitable for storing
PackagePermission objects. |
private static int |
parseActions(java.lang.String actions)
Parse action string into action mask.
|
private static Filter |
parseFilter(java.lang.String filterString)
Parse filter string into a Filter object.
|
private void |
readObject(java.io.ObjectInputStream s)
readObject is called to restore the state of this permission from a
stream.
|
private void |
setTransients(java.lang.String name,
int mask)
Called by constructors and when deserialized.
|
private void |
writeObject(java.io.ObjectOutputStream s)
WriteObject is called to save the state of this permission object to a
stream.
|
static final long serialVersionUID
public static final java.lang.String EXPORT
exportonly
instead.export
. The export
action implies the
import
action.public static final java.lang.String EXPORTONLY
exportonly
. The exportonly
action does
not imply the import
action.public static final java.lang.String IMPORT
import
.private static final int ACTION_EXPORT
private static final int ACTION_IMPORT
private static final int ACTION_ALL
static final int ACTION_NONE
transient int action_mask
private volatile java.lang.String actions
final transient Bundle bundle
transient Filter filter
private transient volatile java.util.Map<java.lang.String,java.lang.Object> properties
public PackagePermission(java.lang.String name, java.lang.String actions)
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:
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.
name
- Package name or filter expression. A filter expression can
only be specified if the specified action is import
.actions
- exportonly
,import
(canonical order).java.lang.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(java.lang.String name, Bundle exportingBundle, java.lang.String actions)
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.name
- The name of the requested package to import.exportingBundle
- The bundle exporting the requested package.actions
- The action import
.java.lang.IllegalArgumentException
- If the specified action is not
import
or the name is a filter expression.PackagePermission(java.lang.String name, int mask)
name
- package namemask
- action maskprivate void setTransients(java.lang.String name, int mask)
mask
- action maskprivate static int parseActions(java.lang.String actions)
actions
- Action string.private static Filter parseFilter(java.lang.String filterString)
filterString
- The filter string to parse.null
is returned.java.lang.IllegalArgumentException
- If the filter syntax is invalid.public boolean implies(java.security.Permission p)
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
implies
in class java.security.BasicPermission
p
- The requested permission.true
if the specified permission is implied by this
object; false
otherwise.boolean implies0(PackagePermission requested, int effective)
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.true
if the specified permission is implied by this
object; false
otherwise.public java.lang.String getActions()
PackagePermission
actions.
Always returns present PackagePermission
actions in the following
order: EXPORTONLY
,IMPORT
.
getActions
in class java.security.BasicPermission
PackagePermission
actions.public java.security.PermissionCollection newPermissionCollection()
PermissionCollection
object suitable for storing
PackagePermission
objects.newPermissionCollection
in class java.security.BasicPermission
PermissionCollection
object.public boolean equals(java.lang.Object obj)
PackagePermission
objects.
This method checks that specified package has the same package name and
PackagePermission
actions as this PackagePermission
object.equals
in class java.security.BasicPermission
obj
- The object to test for equality with this
PackagePermission
object.true
if obj
is a PackagePermission
, and
has the same package name and actions as this
PackagePermission
object; false
otherwise.public int hashCode()
hashCode
in class java.security.BasicPermission
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException
java.io.IOException
private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, java.lang.ClassNotFoundException
java.io.IOException
java.lang.ClassNotFoundException
private java.util.Map<java.lang.String,java.lang.Object> getProperties()
implies(Permission)
. This method is
only called on a requested permission which cannot have a filter set.