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
A bundle's authority to create or use a
Coordination
.
CoordinationPermission
has three actions: initiate
,
participate
and admin
.
- 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 static final int
private String
The actions in canonical form.static final String
The action stringadmin
.(package private) final org.osgi.framework.Bundle
The bundle used by this CoordinationPermission.(package private) org.osgi.framework.Filter
If this CoordinationPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.static final String
The action stringinitiate
.static final String
The action stringparticipate
.This map holds the properties of the permission, used to match a filter in implies.private static final long
-
Constructor Summary
ConstructorsConstructorDescriptionCoordinationPermission
(String filter, String actions) Creates a new grantedCoordinationPermission
object.CoordinationPermission
(String coordinationName, org.osgi.framework.Bundle coordinationBundle, 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
Modifier and TypeMethodDescriptionboolean
Determines the equality of twoCoordinationPermission
objects.Returns the canonical string representation of theCoordinationPermission
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
(CoordinationPermission requested, int effective) Internal implies method.Returns a newPermissionCollection
object suitable for storingCoordinationPermission
objects.private static int
parseActions
(String actions) Parse action string into action mask.private static org.osgi.framework.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
(org.osgi.framework.Filter filter, 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
private static final long serialVersionUID- See Also:
-
INITIATE
The action stringinitiate
.- See Also:
-
PARTICIPATE
The action stringparticipate
.- See Also:
-
ADMIN
The action stringadmin
.- See Also:
-
ACTION_INITIATE
private static final int ACTION_INITIATE- See Also:
-
ACTION_PARTICIPATE
private static final int ACTION_PARTICIPATE- See Also:
-
ACTION_ADMIN
private static final int ACTION_ADMIN- 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
final transient org.osgi.framework.Bundle bundleThe bundle used by this CoordinationPermission. -
filter
transient org.osgi.framework.Filter filterIf this CoordinationPermission 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
-
CoordinationPermission
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, org.osgi.framework.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).
-
CoordinationPermission
CoordinationPermission(org.osgi.framework.Filter filter, int mask) Package private constructor used by CoordinationPermissionCollection.- Parameters:
filter
- name filtermask
- action mask
-
-
Method Details
-
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
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.
- Throws:
IllegalArgumentException
- If the filter syntax is invalid.
-
implies
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.
-
implies0
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
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
Returns a newPermissionCollection
object suitable for storingCoordinationPermission
objects.- Overrides:
newPermissionCollection
in classBasicPermission
- Returns:
- A new
PermissionCollection
object.
-
equals
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.
-
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.
-