Package org.osgi.service.remoteserviceadmin

Class EndpointPermission

  • All Implemented Interfaces:
    java.io.Serializable, java.security.Guard
    public final class EndpointPermission
extends java.security.Permission
    A bundle's authority to export, import or read an Endpoint.
    • The export action allows a bundle to export a service as an Endpoint.
    • The import action allows a bundle to import a service from an Endpoint.
    • The read action allows a bundle to read references to an Endpoint.
    Permission to read an Endpoint is required in order to detect events regarding an Endpoint. Untrusted bundles should not be able to detect the presence of certain Endpoints unless they have the appropriate EndpointPermission to read the specific service.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int ACTION_ALL  
      private static int ACTION_EXPORT  
      private static int ACTION_IMPORT  
      (package private) int action_mask
      The actions mask.
      (package private) static int ACTION_NONE  
      private static int ACTION_READ  
      private java.lang.String actions
      The actions in canonical form.
      (package private) EndpointDescription endpoint
      The endpoint used by this EndpointPermission.
      static java.lang.String EXPORT
      The action string export.
      (package private) org.osgi.framework.Filter filter
      If this EndpointPermission was not constructed with an EndpointDescription, this holds a Filter matching object used to evaluate the filter in implies or null for wildcard.
      static java.lang.String IMPORT
      The action string import.
      private java.util.Dictionary<java.lang.String,​java.lang.Object> properties
      This dictionary holds the properties of the permission, used to match a filter in implies.
      static java.lang.String READ
      The action string read.
      (package private) static long serialVersionUID  

    • Constructor Summary

      Constructors 
      Constructor Description
      EndpointPermission​(java.lang.String name, int mask)
      Package private constructor used by EndpointPermissionCollection.
      EndpointPermission​(java.lang.String filterString, java.lang.String actions)
      Create a new EndpointPermission with the specified filter.
      EndpointPermission​(EndpointDescription endpoint, java.lang.String localFrameworkUUID, java.lang.String actions)
      Creates a new requested EndpointPermission object to be used by code that must perform checkPermission.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.lang.String createName​(EndpointDescription endpoint)
      Create a permission name from a EndpointDescription.
      boolean equals​(java.lang.Object obj)
      Determines the equality of two EndpointPermission objects.
      java.lang.String getActions()
      Returns the canonical string representation of the actions.
      private java.util.Dictionary<java.lang.String,​java.lang.Object> getProperties()
      Called by implies(Permission).
      int hashCode()
      Returns the hash code value for this object.
      boolean implies​(java.security.Permission p)
      Determines if a EndpointPermission object "implies" the specified permission.
      (package private) boolean implies0​(EndpointPermission requested, int effective)
      Internal implies method.
      java.security.PermissionCollection newPermissionCollection()
      Returns a new PermissionCollection object for storing EndpointPermission objects.
      private static int parseActions​(java.lang.String actions)
      Parse action string into action mask.
      private static org.osgi.framework.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​(org.osgi.framework.Filter f, 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 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

      • READ

        public static final java.lang.String READ
        The action string read.
        See Also:
        Constant Field Values

      • IMPORT

        public static final java.lang.String IMPORT
        The action string import. The import action implies the read action.
        See Also:
        Constant Field Values

      • EXPORT

        public static final java.lang.String EXPORT
        The action string export. The export action implies the read action.
        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.

      • endpoint

        final transient EndpointDescription endpoint
        The endpoint used by this EndpointPermission. Must be null if not constructed with a endpoint.

      • properties

        private final transient java.util.Dictionary<java.lang.String,​java.lang.Object> properties
        This dictionary holds the properties of the permission, used to match a filter in implies.

      • filter

        transient org.osgi.framework.Filter filter
        If this EndpointPermission was not constructed with an EndpointDescription, this holds a Filter matching object used to evaluate the filter in implies or null for wildcard.

    • Constructor Detail

      • EndpointPermission

        public EndpointPermission​(java.lang.String filterString,
                          java.lang.String actions)
        Create a new EndpointPermission with the specified filter.

        The filter will be evaluated against the endpoint properties of a requested EndpointPermission.

        There are three possible actions: read, import and export. The read action allows the owner of this permission to see the presence of distributed services. The import action allows the owner of this permission to import an endpoint. The export action allows the owner of this permission to export a service.

        Parameters:
        filterString - The filter string or "*" to match all endpoints.
        actions - The actions read, import, or export.
        Throws:
        java.lang.IllegalArgumentException - If the filter has an invalid syntax or the actions are not valid.

      • EndpointPermission

        public EndpointPermission​(EndpointDescription endpoint,
                          java.lang.String localFrameworkUUID,
                          java.lang.String actions)
        Creates a new requested EndpointPermission object to be used by code that must perform checkPermission. EndpointPermission objects created with this constructor cannot be added to an EndpointPermission permission collection.
        Parameters:
        endpoint - The requested endpoint.
        localFrameworkUUID - The UUID of the local framework. This is used to support matching the endpoint.framework.uuid endpoint property to the <<LOCAL>> value in the filter expression.
        actions - The actions read, import, or export.
        Throws:
        java.lang.IllegalArgumentException - If the endpoint is null or the actions are not valid.

      • EndpointPermission

        EndpointPermission​(java.lang.String name,
                   int mask)
        Package private constructor used by EndpointPermissionCollection.
        Parameters:
        name - class name
        mask - action mask

    • Method Detail

      • createName

        private static java.lang.String createName​(EndpointDescription endpoint)
        Create a permission name from a EndpointDescription.
        Parameters:
        endpoint - EndpointDescription to use to create permission name.
        Returns:
        permission name.

      • setTransients

        private void setTransients​(org.osgi.framework.Filter f,
                           int mask)
        Called by constructors and when deserialized.
        Parameters:
        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 org.osgi.framework.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 a EndpointPermission object "implies" the specified permission.
        Specified by:
        implies in class java.security.Permission
        Parameters:
        p - The target permission to check.
        Returns:
        true if the specified permission is implied by this object; false otherwise.

      • implies0

        boolean implies0​(EndpointPermission requested,
                 int effective)
        Internal implies method. Used by the implies and the permission collection implies methods.
        Parameters:
        requested - The requested EndpointPermission which has already be validated as a proper argument. The requested EndpointPermission 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 actions. Always returns present actions in the following canonical order: read, import, export.
        Specified by:
        getActions in class java.security.Permission
        Returns:
        The canonical string representation of the actions.

      • newPermissionCollection

        public java.security.PermissionCollection newPermissionCollection()
        Returns a new PermissionCollection object for storing EndpointPermission objects.
        Overrides:
        newPermissionCollection in class java.security.Permission
        Returns:
        A new PermissionCollection object suitable for storing EndpointPermission objects.

      • equals

        public boolean equals​(java.lang.Object obj)
        Determines the equality of two EndpointPermission objects. Checks that specified object has the same name, actions and endpoint as this EndpointPermission.
        Specified by:
        equals in class java.security.Permission
        Parameters:
        obj - The object to test for equality.
        Returns:
        true If obj is a EndpointPermission, and has the same name, actions and endpoint as this EndpointPermission object; false otherwise.

      • hashCode

        public int hashCode()
        Returns the hash code value for this object.
        Specified by:
        hashCode in class java.security.Permission
        Returns:
        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 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.Dictionary<java.lang.String,​java.lang.Object> getProperties()
        Called by implies(Permission).
        Returns:
        a dictionary of properties for this permission.