Package org.osgi.service.coordinator
Class CoordinationPermission
- java.lang.Object
-
- java.security.Permission
-
- java.security.BasicPermission
-
- org.osgi.service.coordinator.CoordinationPermission
-
- All Implemented Interfaces:
java.io.Serializable
,java.security.Guard
public final class CoordinationPermission extends java.security.BasicPermission
A bundle's authority to create or use aCoordination
.CoordinationPermission
has three actions:initiate
,participate
andadmin
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static int
ACTION_ADMIN
private static int
ACTION_ALL
private static int
ACTION_INITIATE
(package private) int
action_mask
The actions mask.(package private) static int
ACTION_NONE
private static int
ACTION_PARTICIPATE
private java.lang.String
actions
The actions in canonical form.static java.lang.String
ADMIN
The action stringadmin
.(package private) org.osgi.framework.Bundle
bundle
The bundle used by this CoordinationPermission.(package private) org.osgi.framework.Filter
filter
If this CoordinationPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.static java.lang.String
INITIATE
The action stringinitiate
.static java.lang.String
PARTICIPATE
The action stringparticipate
.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.private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description CoordinationPermission(java.lang.String filter, java.lang.String actions)
Creates a new grantedCoordinationPermission
object.CoordinationPermission(java.lang.String coordinationName, org.osgi.framework.Bundle coordinationBundle, java.lang.String actions)
Creates a new requestedCoordinationPermission
object to be used by the code that must performcheckPermission
.CoordinationPermission(org.osgi.framework.Filter filter, int mask)
Package private constructor used by CoordinationPermissionCollection.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Determines the equality of twoCoordinationPermission
objects.java.lang.String
getActions()
Returns the canonical string representation of theCoordinationPermission
actions.private java.util.Map<java.lang.String,java.lang.Object>
getProperties()
Called byimplies(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(CoordinationPermission requested, int effective)
Internal implies method.java.security.PermissionCollection
newPermissionCollection()
Returns a newPermissionCollection
object suitable for storingCoordinationPermission
objects.private static int
parseActions(java.lang.String actions)
Parse action string into action mask.private static org.osgi.framework.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(org.osgi.framework.Filter filter, 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.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
INITIATE
public static final java.lang.String INITIATE
The action stringinitiate
.- See Also:
- Constant Field Values
-
PARTICIPATE
public static final java.lang.String PARTICIPATE
The action stringparticipate
.- See Also:
- Constant Field Values
-
ADMIN
public static final java.lang.String ADMIN
The action stringadmin
.- See Also:
- Constant Field Values
-
ACTION_INITIATE
private static final int ACTION_INITIATE
- See Also:
- Constant Field Values
-
ACTION_PARTICIPATE
private static final int ACTION_PARTICIPATE
- See Also:
- Constant Field Values
-
ACTION_ADMIN
private static final int ACTION_ADMIN
- See Also:
- Constant Field Values
-
ACTION_ALL
private static final int ACTION_ALL
- See Also:
- Constant Field Values
-
ACTION_NONE
static final int ACTION_NONE
- See Also:
- Constant Field Values
-
action_mask
transient int action_mask
The actions mask.
-
actions
private volatile java.lang.String actions
The actions in canonical form.
-
bundle
final transient org.osgi.framework.Bundle bundle
The bundle used by this CoordinationPermission.
-
filter
transient org.osgi.framework.Filter filter
If this CoordinationPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.
-
properties
private transient volatile 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. This is not initialized until necessary, and then cached in this object.
-
-
Constructor Detail
-
CoordinationPermission
public CoordinationPermission(java.lang.String filter, java.lang.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:
java.lang.IllegalArgumentException
- If the filter has an invalid syntax.
-
CoordinationPermission
public CoordinationPermission(java.lang.String coordinationName, org.osgi.framework.Bundle coordinationBundle, java.lang.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).
-
CoordinationPermission
CoordinationPermission(org.osgi.framework.Filter filter, int mask)
Package private constructor used by CoordinationPermissionCollection.- Parameters:
filter
- name filtermask
- action mask
-
-
Method Detail
-
setTransients
private void setTransients(org.osgi.framework.Filter filter, int mask)
Called by constructors and when deserialized.- Parameters:
filter
- Permission's filter ornull
for wildcard.mask
- action mask
-
parseActions
private static int parseActions(java.lang.String actions)
Parse action string into action mask.- Parameters:
actions
- Action string.- Returns:
- action mask.
-
parseFilter
private static org.osgi.framework.Filter parseFilter(java.lang.String filterString)
Parse filter string into a Filter object.- Parameters:
filterString
- The filter string to parse.- Returns:
- a Filter for this bundle.
- Throws:
java.lang.IllegalArgumentException
- If the filter syntax is invalid.
-
implies
public boolean implies(java.security.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 classjava.security.BasicPermission
- Parameters:
p
- The requested permission.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
implies0
boolean implies0(CoordinationPermission requested, int effective)
Internal implies method. Used by the implies and the permission collection implies methods.- Parameters:
requested
- The requested CoordinationPermission which has already be validated as a proper argument. The requested CoordinationPermission 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
public java.lang.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 classjava.security.BasicPermission
- Returns:
- Canonical string representation of the
CoordinationPermission
actions.
-
newPermissionCollection
public java.security.PermissionCollection newPermissionCollection()
Returns a newPermissionCollection
object suitable for storingCoordinationPermission
objects.- Overrides:
newPermissionCollection
in classjava.security.BasicPermission
- Returns:
- A new
PermissionCollection
object.
-
equals
public boolean equals(java.lang.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 classjava.security.BasicPermission
- 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 classjava.security.BasicPermission
- Returns:
- A hash code value for this object.
-
writeObject
private void writeObject(java.io.ObjectOutputStream s) throws java.io.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.- Throws:
java.io.IOException
-
readObject
private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, java.lang.ClassNotFoundException
readObject is called to restore the state of this permission from a stream.- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
getProperties
private java.util.Map<java.lang.String,java.lang.Object> 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.
-
-