Package org.osgi.service.typedevent

Class TopicPermission

java.lang.Object
java.security.Permission
org.osgi.service.typedevent.TopicPermission
All Implemented Interfaces:
Serializable, Guard
public final class TopicPermission extends Permission
A bundle's authority to publish or subscribe to typed events on a topic.

A topic is a slash-separated string that defines a topic.

For example: 

 org / osgi / service / foo / FooEvent / ACTION

Topics may also be given a default name based on the event type that is published to the topic. These use the fully qualified class name of the event object as the name of the topic.

For example: 

 com.acme.foo.event.EventData

TopicPermission has two actions: publish and subscribe.

See Also:
"ThreadSafe"

  • Field Details

  • Constructor Details

    • TopicPermission

      public TopicPermission(String name, String actions)
      Defines the authority to publish and/or subscribe to a topic within the Typed Event service specification.

      The name is specified as a slash-separated string. Wildcards may be used. For example: 

          org/osgi/service/fooFooEvent/ACTION
    com/isv/*
    *

      A bundle that needs to publish events on a topic must have the appropriate TopicPermission for that topic; similarly, a bundle that needs to subscribe to events on a topic must have the appropriate TopicPermssion for that topic.

      Parameters:
      name - Topic name.
      actions - publish,subscribe (canonical order).

  • Method Details

    • implies

      public boolean implies(Permission p)
      Determines if the specified permission is implied by this object.

      This method checks that the topic name of the target is implied by the topic name of this object. The list of TopicPermission actions must either match or allow for the list of the target object to imply the target TopicPermission action. 

          x/y/*,"publish" -> x/y/z,"publish" is true
    *,"subscribe" -> x/y,"subscribe"   is true
    *,"publish" -> x/y,"subscribe"     is false
    x/y,"publish" -> x/y/z,"publish"   is false
      Specified by:
      implies in class Permission
      Parameters:
      p - The target permission to interrogate.
      Returns:
      true if the specified TopicPermission action is implied by this object; false otherwise.

    • getActions

      public String getActions()
      Returns the canonical string representation of the TopicPermission actions.

      Always returns present TopicPermission actions in the following order: publish,subscribe.

      Specified by:
      getActions in class Permission
      Returns:
      Canonical string representation of the TopicPermission actions.

    • newPermissionCollection

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

    • equals

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

    • hashCode

      public int hashCode()
      Returns the hash code value for this object.
      Specified by:
      hashCode in class Permission
      Returns:
      A hash code value for this object.