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 a Coordination.

CoordinationPermission has three actions: initiate, participate and admin.

See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • INITIATE

      public static final String INITIATE
      The action string initiate.
      See Also:

    • PARTICIPATE

      public static final String PARTICIPATE
      The action string participate.
      See Also:

    • ADMIN

      public static final String ADMIN
      The action string admin.
      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_mask
      The actions mask.

    • actions

      private volatile 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 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.

  • Constructor Details

    • CoordinationPermission

      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 - 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 or participate (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 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 - The name of the requested Coordination.
      coordinationBundle - The bundle which created the requested Coordination.
      actions - admin, initiate or participate (canonical order).

    • CoordinationPermission

      CoordinationPermission(org.osgi.framework.Filter filter, int mask)
      Package private constructor used by CoordinationPermissionCollection.
      Parameters:
      filter - name filter
      mask - 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 or null for wildcard.
      mask - action mask

    • parseActions

      private static int parseActions(String actions)
      Parse action string into action mask.
      Parameters:
      actions - Action string.
      Returns:
      action mask.

    • parseFilter

      private static org.osgi.framework.Filter parseFilter(String filterString)
      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

      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 target CoordinationPermission action.

      Overrides:
      implies in class 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 String getActions()
      Returns the canonical string representation of the CoordinationPermission actions.

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

      Overrides:
      getActions in class BasicPermission
      Returns:
      Canonical string representation of the CoordinationPermission actions.

    • newPermissionCollection

      public PermissionCollection newPermissionCollection()
      Returns a new PermissionCollection object suitable for storing CoordinationPermission objects.
      Overrides:
      newPermissionCollection in class BasicPermission
      Returns:
      A new PermissionCollection object.

    • equals

      public boolean equals(Object obj)
      Determines the equality of two CoordinationPermission objects. This method checks that specified permission has the same name and CoordinationPermission actions as this CoordinationPermission object.
      Overrides:
      equals in class BasicPermission
      Parameters:
      obj - The object to test for equality with this CoordinationPermission object.
      Returns:
      true if obj is a CoordinationPermission, and has the same name and actions as this CoordinationPermission object; false otherwise.

    • hashCode

      public int hashCode()
      Returns the hash code value for this object.
      Overrides:
      hashCode in class BasicPermission
      Returns:
      A hash code value for this object.

    • writeObject

      private 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.
      Throws:
      IOException

    • readObject

      private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException
      readObject is called to restore the state of this permission from a stream.
      Throws:
      IOException
      ClassNotFoundException

    • getProperties

      private Map<String,Object> getProperties()
      Called by implies(Permission). This method is only called on a requested permission which cannot have a filter set.
      Returns:
      a map of properties for this permission.