Class AdaptPermission

java.lang.Object
java.security.Permission
java.security.BasicPermission
org.osgi.framework.AdaptPermission
All Implemented Interfaces:
Serializable, Guard
public final class AdaptPermission extends BasicPermission
A bundle's authority to adapt an object to a type.

AdaptPermission has one action: adapt.

See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • ADAPT

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

    • ACTION_ADAPT

      private static final int ACTION_ADAPT
      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 Bundle bundle
      The bundle used by this AdaptPermission.

    • filter

      transient Filter 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

    • AdaptPermission

      public AdaptPermission(String filter, String actions)
      Creates a new granted AdaptPermission object. This constructor must only be used to create a permission that is going to be checked.

      Examples: 

      (adaptClass=com.acme.*)
(&(signer=\*,o=ACME,c=US)(adaptClass=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.
      • adaptClass - The name of the type to which an object can be adapted.
      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 adaptations.
      actions - adapt.
      Throws:
      IllegalArgumentException - If the filter has an invalid syntax.

    • AdaptPermission

      public AdaptPermission(String adaptClass, Bundle adaptableBundle, String actions)
      Creates a new requested AdaptPermission object to be used by the code that must perform checkPermission. AdaptPermission objects created with this constructor cannot be added to an AdaptPermission permission collection.
      Parameters:
      adaptClass - The name of the type to which an object can be adapted.
      adaptableBundle - The bundle associated with the object being adapted.
      actions - adapt.

    • AdaptPermission

      AdaptPermission(Filter filter, int mask)
      Package private constructor used by AdaptPermissionCollection.
      Parameters:
      filter - name filter
      mask - action mask

  • Method Details

    • setTransients

      private void setTransients(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 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 adapt class name of this object. The list of AdaptPermission actions must either match or allow for the list of the target object to imply the target AdaptPermission 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(AdaptPermission requested, int effective)
      Internal implies method. Used by the implies and the permission collection implies methods.
      Parameters:
      requested - The requested AdaptPermission which has already be validated as a proper argument. The requested AdaptPermission 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 AdaptPermission actions.

      Always returns present AdaptPermission actions in the following order: adapt.

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

    • newPermissionCollection

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

    • equals

      public boolean equals(Object obj)
      Determines the equality of two AdaptPermission objects. This method checks that specified permission has the same name and AdaptPermission actions as this AdaptPermission object.
      Overrides:
      equals in class BasicPermission
      Parameters:
      obj - The object to test for equality with this AdaptPermission object.
      Returns:
      true if obj is a AdaptPermission, and has the same name and actions as this AdaptPermission 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.