Top Description Fields Constructors Methods
org.osgi.service.coordinator

public final Class CoordinationPermission

Additional top-level classes in compilation unit: SignerProperty, CoordinationPermissionCollection.

extends BasicPermission
Class Inheritance
Imports
java.io.IOException, .NotSerializableException, .ObjectInputStream, .ObjectOutputStream, .ObjectStreamField, java.security.AccessController, .BasicPermission, .Permission, .PermissionCollection, .PrivilegedAction, java.security.cert.X509Certificate, java.util.ArrayList, .Collection, .Collections, .Enumeration, .HashMap, .List, .Map, org.osgi.framework.Bundle, .Filter, .FrameworkUtil, .InvalidSyntaxException
A bundle's authority to create or use a Coordination.

CoordinationPermission has three actions: initiate, participate and admin.

Author
$Id: 7892b43ca8617d1a0437fc5efe9c6f083ee6bf89 $

Field Summary

Modifier and TypeField and Description
private static final int
ACTION_ADMIN

private static final int
ACTION_ALL

private static final int
ACTION_INITIATE

pack-priv transient int
action_mask

The actions mask.

pack-priv static final int
ACTION_NONE

private static final int
ACTION_PARTICIPATE

private volatile String
actions

The actions in canonical form.

public static final String
ADMIN

The action string admin.

pack-priv final transient Bundle
bundle

The bundle used by this CoordinationPermission.

pack-priv transient Filter
filter

If this CoordinationPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.

public static final String
INITIATE

The action string initiate.

public static final String
PARTICIPATE

The action string participate.

private transient volatile Map<String, Object>
properties

This map holds the properties of the permission, used to match a filter in implies.

private static final long
serialVersionUID

Hides java.security.BasicPermission.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
CoordinationPermission(String
A filter expression. Filter attribute names are processed in a case sensitive manner. A special value of "*" can be used to match all coordinations.
filter, String
admin, initiate or participate (canonical order).
actions)

Creates a new granted CoordinationPermission object.

public
CoordinationPermission(String
The name of the requested Coordination.
coordinationName, Bundle
The bundle which created the requested Coordination.
coordinationBundle, String
admin, initiate or participate (canonical order).
actions)

Creates a new requested CoordinationPermission object to be used by the code that must perform checkPermission.

pack-priv
CoordinationPermission(Filter
name filter
filter, int
action mask
mask)

Package private constructor used by CoordinationPermissionCollection.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if obj is a CoordinationPermission, and has the same name and actions as this CoordinationPermission object; false otherwise.
equals(Object
The object to test for equality with this CoordinationPermission object.
obj)

Overrides java.security.BasicPermission.equals.

Determines the equality of two CoordinationPermission objects.

public String

Returns:

Canonical string representation of the CoordinationPermission actions.
getActions()

Overrides java.security.BasicPermission.getActions.

Returns the canonical string representation of the CoordinationPermission actions.

private Map<String, Object>

Returns:

a map of properties for this permission.
getProperties()

Called by CoordinationPermission#implies(Permission).

public int

Returns:

A hash code value for this object.
hashCode()

Overrides java.security.BasicPermission.hashCode.

Returns the hash code value for this object.

public boolean

Returns:

true if the specified permission is implied by this object; false otherwise.
implies(Permission
The requested permission.
p)

Overrides java.security.BasicPermission.implies.

Determines if the specified permission is implied by this object.

pack-priv boolean

Returns:

true if the specified permission is implied by this object; false otherwise.
implies0(CoordinationPermission
The requested CoordinationPermission which has already be validated as a proper argument. The requested CoordinationPermission must not have a filter expression.
requested, int
The effective actions with which to start.
effective)

Internal implies method.

public PermissionCollection

Returns:

A new PermissionCollection object.
newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection object suitable for storing CoordinationPermission objects.

private static int

Returns:

action mask.
parseActions(String
Action string.
actions)

Parse action string into action mask.

private static Filter

Returns:

a Filter for this bundle.
parseFilter(String
The filter string to parse.
filterString)

Parse filter string into a Filter object.

private synchronized void
readObject(ObjectInputStream
the ObjectInputStream from which data is read
s)

Hides java.security.BasicPermission.readObject.

readObject is called to restore the state of this permission from a stream.

private void
setTransients(Filter
Permission's filter or null for wildcard.
filter, int
action mask
mask)

Called by constructors and when deserialized.

private synchronized void
writeObject(ObjectOutputStream s)

WriteObject is called to save the state of this permission object to a stream.

Field Detail

ACTION_ADMINback to summary
private static final int ACTION_ADMIN
ACTION_ALLback to summary
private static final int ACTION_ALL
ACTION_INITIATEback to summary
private static final int ACTION_INITIATE
action_maskback to summary
pack-priv transient int action_mask

The actions mask.

ACTION_NONEback to summary
pack-priv static final int ACTION_NONE
ACTION_PARTICIPATEback to summary
private static final int ACTION_PARTICIPATE
actionsback to summary
private volatile String actions

The actions in canonical form.

ADMINback to summary
public static final String ADMIN

The action string admin.

bundleback to summary
pack-priv final transient Bundle bundle

The bundle used by this CoordinationPermission.

filterback to summary
pack-priv transient Filter filter

If this CoordinationPermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.

INITIATEback to summary
public static final String INITIATE

The action string initiate.

PARTICIPATEback to summary
public static final String PARTICIPATE

The action string participate.

propertiesback to summary
private transient volatile Map<String, 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.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.security.BasicPermission.serialVersionUID.

Constructor Detail

CoordinationPermissionback to summary
public CoordinationPermission(String filter, String actions)

Creates a new granted CoordinationPermission 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.
Filter attribute names are processed in a case sensitive manner.
Parameters
filter:String

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:String

admin, initiate or participate (canonical order).

Exceptions
IllegalArgumentException:
If the filter has an invalid syntax.
CoordinationPermissionback to summary
public CoordinationPermission(String coordinationName, Bundle coordinationBundle, String actions)

Creates a new requested CoordinationPermission object to be used by the code that must perform checkPermission. CoordinationPermission objects created with this constructor cannot be added to an CoordinationPermission permission collection.

Parameters
coordinationName:String

The name of the requested Coordination.

coordinationBundle:Bundle

The bundle which created the requested Coordination.

actions:String

admin, initiate or participate (canonical order).

CoordinationPermissionback to summary
pack-priv CoordinationPermission(Filter filter, int mask)

Package private constructor used by CoordinationPermissionCollection.

Parameters
filter:Filter

name filter

mask:int

action mask

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

Determines the equality of two CoordinationPermission objects. This method checks that specified permission has the same name and CoordinationPermission actions as this CoordinationPermission object.

Parameters
obj:Object

The object to test for equality with this CoordinationPermission object.

Returns:boolean

true if obj is a CoordinationPermission, and has the same name and actions as this CoordinationPermission object; false otherwise.

Annotations
@Override
getActionsback to summary
public String getActions()

Overrides java.security.BasicPermission.getActions.

Returns the canonical string representation of the CoordinationPermission actions.

Always returns present CoordinationPermission actions in the following order: admin, initiate, participate.

Returns:String

Canonical string representation of the CoordinationPermission actions.

Annotations
@Override
getPropertiesback to summary
private Map<String, Object> getProperties()

Called by CoordinationPermission#implies(Permission). This method is only called on a requested permission which cannot have a filter set.

Returns:Map<String, Object>

a map of properties for this permission.

hashCodeback to summary
public int hashCode()

Overrides java.security.BasicPermission.hashCode.

Returns the hash code value for this object.

Returns:int

A hash code value for this object.

Annotations
@Override
impliesback to summary
public boolean implies(Permission p)

Overrides java.security.BasicPermission.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 target CoordinationPermission action.

Parameters
p:Permission

The requested permission.

Returns:boolean

true if the specified permission is implied by this object; false otherwise.

Annotations
@Override
implies0back to summary
pack-priv boolean implies0(CoordinationPermission requested, int effective)

Internal implies method. Used by the implies and the permission collection implies methods.

Parameters
requested:CoordinationPermission

The requested CoordinationPermission which has already be validated as a proper argument. The requested CoordinationPermission must not have a filter expression.

effective:int

The effective actions with which to start.

Returns:boolean

true if the specified permission is implied by this object; false otherwise.

newPermissionCollectionback to summary
public PermissionCollection newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection object suitable for storing CoordinationPermission objects.

Returns:PermissionCollection

A new PermissionCollection object.

Annotations
@Override
parseActionsback to summary
private static int parseActions(String actions)

Parse action string into action mask.

Parameters
actions:String

Action string.

Returns:int

action mask.

parseFilterback to summary
private static Filter parseFilter(String filterString)

Parse filter string into a Filter object.

Parameters
filterString:String

The filter string to parse.

Returns:Filter

a Filter for this bundle.

Exceptions
IllegalArgumentException:
If the filter syntax is invalid.
readObjectback to summary
private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Hides java.security.BasicPermission.readObject.

readObject is called to restore the state of this permission from a stream.

Parameters
s:ObjectInputStream

Doc from java.security.BasicPermission.readObject.

the ObjectInputStream from which data is read

Exceptions
IOException:

Doc from java.security.BasicPermission.readObject.

if an I/O error occurs

ClassNotFoundException:

Doc from java.security.BasicPermission.readObject.

if a serialized class cannot be loaded

setTransientsback to summary
private void setTransients(Filter filter, int mask)

Called by constructors and when deserialized.

Parameters
filter:Filter

Permission's filter or null for wildcard.

mask:int

action mask

writeObjectback to summary
private synchronized void writeObject(ObjectOutputStream s) throws 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.