Class AdaptPermission

  • All Implemented Interfaces:
    java.io.Serializable, java.security.Guard

    public final class AdaptPermission
    extends java.security.BasicPermission
    A bundle's authority to adapt an object to a type.

    AdaptPermission has one action: adapt.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int ACTION_ADAPT  
      private static int ACTION_ALL  
      (package private) int action_mask
      The actions mask.
      (package private) static int ACTION_NONE  
      private java.lang.String actions
      The actions in canonical form.
      static java.lang.String ADAPT
      The action string initiate.
      (package private) Bundle bundle
      The bundle used by this AdaptPermission.
      (package private) Filter filter
      This holds a Filter matching object used to evaluate the filter in implies.
      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
      AdaptPermission​(java.lang.String filter, java.lang.String actions)
      Creates a new granted AdaptPermission object.
      AdaptPermission​(java.lang.String adaptClass, Bundle adaptableBundle, java.lang.String actions)
      Creates a new requested AdaptPermission object to be used by the code that must perform checkPermission.
      AdaptPermission​(Filter filter, int mask)
      Package private constructor used by AdaptPermissionCollection.
    • 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 two AdaptPermission objects.
      java.lang.String getActions()
      Returns the canonical string representation of the AdaptPermission actions.
      private java.util.Map<java.lang.String,​java.lang.Object> getProperties()
      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​(AdaptPermission requested, int effective)
      Internal implies method.
      java.security.PermissionCollection newPermissionCollection()
      Returns a new PermissionCollection object suitable for storing AdaptPermission objects.
      private static int parseActions​(java.lang.String actions)
      Parse action string into action mask.
      private static 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​(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.
      • Methods inherited from class java.security.Permission

        checkGuard, getName, toString
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • ADAPT

        public static final java.lang.String ADAPT
        The action string initiate.
        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 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 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

      • AdaptPermission

        public AdaptPermission​(java.lang.String filter,
                               java.lang.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:
        java.lang.IllegalArgumentException - If the filter has an invalid syntax.
      • AdaptPermission

        public AdaptPermission​(java.lang.String adaptClass,
                               Bundle adaptableBundle,
                               java.lang.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 Detail

      • 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​(java.lang.String actions)
        Parse action string into action mask.
        Parameters:
        actions - Action string.
        Returns:
        action mask.
      • parseFilter

        private static 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 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 java.security.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 java.lang.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 java.security.BasicPermission
        Returns:
        Canonical string representation of the AdaptPermission actions.
      • newPermissionCollection

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

        public boolean equals​(java.lang.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 java.security.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 java.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 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.