Package org.osgi.service.coordinator
Class CoordinationPermission
- java.lang.Object
-
- java.security.Permission
-
- java.security.BasicPermission
-
- org.osgi.service.coordinator.CoordinationPermission
-
- All Implemented Interfaces:
Serializable
,Guard
public final class CoordinationPermission extends BasicPermission
A bundle's authority to create or use aCoordination
.CoordinationPermission
has three actions:initiate
,participate
andadmin
.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CoordinationPermission(String filter, String actions)
Creates a new grantedCoordinationPermission
object.CoordinationPermission(String coordinationName, Bundle coordinationBundle, String actions)
Creates a new requestedCoordinationPermission
object to be used by the code that must performcheckPermission
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Determines the equality of twoCoordinationPermission
objects.String
getActions()
Returns the canonical string representation of theCoordinationPermission
actions.int
hashCode()
Returns the hash code value for this object.boolean
implies(Permission p)
Determines if the specified permission is implied by this object.PermissionCollection
newPermissionCollection()
Returns a newPermissionCollection
object suitable for storingCoordinationPermission
objects.-
Methods inherited from class java.security.Permission
checkGuard, getName, toString
-
-
-
-
Field Detail
-
INITIATE
public static final String INITIATE
The action stringinitiate
.- See Also:
- Constant Field Values
-
PARTICIPATE
public static final String PARTICIPATE
The action stringparticipate
.- See Also:
- Constant Field Values
-
ADMIN
public static final String ADMIN
The action stringadmin
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CoordinationPermission
public CoordinationPermission(String filter, String actions)
Creates a new grantedCoordinationPermission
object. This constructor must only be used to create a permission that is going to be checked.Examples:
(coordination.name=com.acme.*) (&(signer=\*,o=ACME,c=US)(coordination.name=com.acme.*)) (signer=\*,o=ACME,c=US)
When a signer key is used within the filter expression the signer value must escape the special filter chars ('*', '(', ')').
The name is specified as 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.
- coordination.name - The name of the requested coordination.
- Parameters:
filter
- A filter expression. Filter attribute names are processed in a case sensitive manner. A special value of"*"
can be used to match all coordinations.actions
-admin
,initiate
orparticipate
(canonical order).- Throws:
IllegalArgumentException
- If the filter has an invalid syntax.
-
CoordinationPermission
public CoordinationPermission(String coordinationName, Bundle coordinationBundle, String actions)
Creates a new requestedCoordinationPermission
object to be used by the code that must performcheckPermission
.CoordinationPermission
objects created with this constructor cannot be added to anCoordinationPermission
permission collection.- Parameters:
coordinationName
- The name of the requested Coordination.coordinationBundle
- The bundle whichcreated
the requested Coordination.actions
-admin
,initiate
orparticipate
(canonical order).
-
-
Method Detail
-
implies
public boolean implies(Permission p)
Determines if the specified permission is implied by this object.This method checks that the filter of the target is implied by the coordination name of this object. The list of
CoordinationPermission
actions must either match or allow for the list of the target object to imply the targetCoordinationPermission
action.- Overrides:
implies
in classBasicPermission
- Parameters:
p
- The requested permission.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
getActions
public String getActions()
Returns the canonical string representation of theCoordinationPermission
actions.Always returns present
CoordinationPermission
actions in the following order:admin
,initiate
,participate
.- Overrides:
getActions
in classBasicPermission
- Returns:
- Canonical string representation of the
CoordinationPermission
actions.
-
newPermissionCollection
public PermissionCollection newPermissionCollection()
Returns a newPermissionCollection
object suitable for storingCoordinationPermission
objects.- Overrides:
newPermissionCollection
in classBasicPermission
- Returns:
- A new
PermissionCollection
object.
-
equals
public boolean equals(Object obj)
Determines the equality of twoCoordinationPermission
objects. This method checks that specified permission has the same name andCoordinationPermission
actions as thisCoordinationPermission
object.- Overrides:
equals
in classBasicPermission
- Parameters:
obj
- The object to test for equality with thisCoordinationPermission
object.- Returns:
true
ifobj
is aCoordinationPermission
, and has the same name and actions as thisCoordinationPermission
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.
-
-