Package org.osgi.service.remoteserviceadmin

Class EndpointPermission

java.lang.Object
java.security.Permission
org.osgi.service.remoteserviceadmin.EndpointPermission
All Implemented Interfaces:
Serializable, Guard
public final class EndpointPermission extends 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:

  • Field Details

    • serialVersionUID

      static final long serialVersionUID
      See Also:

    • READ

      public static final String READ
      The action string read.
      See Also:

    • IMPORT

      public static final String IMPORT
      The action string import. The import action implies the read action.
      See Also:

    • EXPORT

      public static final String EXPORT
      The action string export. The export action implies the read action.
      See Also:

    • ACTION_READ

      private static final int ACTION_READ
      See Also:

    • ACTION_IMPORT

      private static final int ACTION_IMPORT
      See Also:

    • ACTION_EXPORT

      private static final int ACTION_EXPORT
      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.

    • endpoint

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

    • properties

      private final transient Dictionary<String,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 Details

    • EndpointPermission

      public EndpointPermission(String filterString, 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:
      IllegalArgumentException - If the filter has an invalid syntax or the actions are not valid.

    • EndpointPermission

      public EndpointPermission(EndpointDescription endpoint, String localFrameworkUUID, 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:
      IllegalArgumentException - If the endpoint is null or the actions are not valid.

    • EndpointPermission

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

  • Method Details

    • createName

      private static 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(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 a EndpointPermission object "implies" the specified permission.
      Specified by:
      implies in class 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 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 Permission
      Returns:
      The canonical string representation of the actions.

    • newPermissionCollection

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

    • equals

      public boolean equals(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 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 Permission
      Returns:
      Hash code value for this object.

    • writeObject

      private void writeObject(ObjectOutputStream s) throws 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:
      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 Dictionary<String,Object> getProperties()
      Called by implies(Permission).
      Returns:
      a dictionary of properties for this permission.