Package org.osgi.framework
Class CapabilityPermission
java.lang.Object
java.security.Permission
java.security.BasicPermission
org.osgi.framework.CapabilityPermission
- All Implemented Interfaces:
Serializable
,Guard
A bundle's authority to provide or require a capability.
- The
provide
action allows a bundle to provide a capability matching the specified filter. - The
require
action allows a bundle to require a capability matching the specified filter.
- Since:
- 1.6
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionCapabilityPermission
(String name, String actions) Create a new CapabilityPermission.CapabilityPermission
(String namespace, Map<String, ?> attributes, Bundle providingBundle, String actions) Creates a new requestedCapabilityPermission
object to be used by code that must performcheckPermission
for therequire
action. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines the equality of two CapabilityPermission objects.Returns the canonical string representation of the actions.int
hashCode()
Returns the hash code value for this object.boolean
Determines if aCapabilityPermission
object "implies" the specified permission.Returns a newPermissionCollection
object for storingCapabilityPermission
objects.Methods inherited from class java.security.Permission
checkGuard, getName, toString
-
Field Details
-
REQUIRE
The action stringrequire
.- See Also:
-
PROVIDE
The action stringprovide
.- See Also:
-
-
Constructor Details
-
CapabilityPermission
Create a new CapabilityPermission.The name is specified as a dot-separated string. Wildcards may be used.
name ::= <namespace> | <namespace ending in ".*"> | *
Examples:com.acme.capability.* org.foo.capability *
For therequire
action, the name can also be a filter expression. The filter gives access to the capability attributes as well as the following attributes:- signer - A Distinguished Name chain used to sign the bundle providing the capability. 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 bundle providing the capability.
- id - The bundle ID of the bundle providing the capability.
- name - The symbolic name of the bundle providing the capability.
- capability.namespace - The namespace of the required capability.
There are two possible actions:
require
andprovide
. Therequire
permission allows the owner of this permission to require a capability matching the attributes. Theprovide
permission allows the bundle to provide a capability in the specified capability namespace.- Parameters:
name
- The capability namespace or a filter over the attributes.actions
-require
,provide
(canonical order)- Throws:
IllegalArgumentException
- If the specified name is a filter expression and either the specified action is notrequire
or the filter has an invalid syntax.
-
CapabilityPermission
public CapabilityPermission(String namespace, Map<String, ?> attributes, Bundle providingBundle, String actions) Creates a new requestedCapabilityPermission
object to be used by code that must performcheckPermission
for therequire
action.CapabilityPermission
objects created with this constructor cannot be added to aCapabilityPermission
permission collection.- Parameters:
namespace
- The requested capability namespace.attributes
- The requested capability attributes.providingBundle
- The bundle providing the requested capability.actions
- The actionrequire
.- Throws:
IllegalArgumentException
- If the specified action is notrequire
or attributes or providingBundle arenull
.
-
-
Method Details
-
implies
Determines if aCapabilityPermission
object "implies" the specified permission.- Overrides:
implies
in classBasicPermission
- Parameters:
p
- The target permission to check.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
getActions
Returns the canonical string representation of the actions. Always returns present actions in the following order:require
,provide
.- Overrides:
getActions
in classBasicPermission
- Returns:
- The canonical string representation of the actions.
-
newPermissionCollection
Returns a newPermissionCollection
object for storingCapabilityPermission
objects.- Overrides:
newPermissionCollection
in classBasicPermission
- Returns:
- A new
PermissionCollection
object suitable for storingCapabilityPermission
objects.
-
equals
Determines the equality of two CapabilityPermission objects. Checks that specified object has the same name and action as thisCapabilityPermission
.- Overrides:
equals
in classBasicPermission
- Parameters:
obj
- The object to test for equality.- Returns:
- true if obj is a
CapabilityPermission
, and has the same name and actions as thisCapabilityPermission
object;false
otherwise.
-
hashCode
public int hashCode()Returns the hash code value for this object.- Overrides:
hashCode
in classBasicPermission
- Returns:
- Hash code value for this object.
-