Class TopicPermission
- java.lang.Object
-
- java.security.Permission
-
- org.osgi.service.event.TopicPermission
-
- All Implemented Interfaces:
java.io.Serializable
,java.security.Guard
public final class TopicPermission extends java.security.Permission
A bundle's authority to publish or subscribe to event on a topic.A topic is a slash-separated string that defines a topic.
For example:
org/osgi/service/foo/FooEvent/ACTION
TopicPermission
has two actions:publish
andsubscribe
.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TopicPermission(java.lang.String name, java.lang.String actions)
Defines the authority to publish and/or subscribe to a topic within the EventAdmin service.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Determines the equality of twoTopicPermission
objects.java.lang.String
getActions()
Returns the canonical string representation of theTopicPermission
actions.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.java.security.PermissionCollection
newPermissionCollection()
Returns a newPermissionCollection
object suitable for storingTopicPermission
objects.
-
-
-
Field Detail
-
PUBLISH
public static final java.lang.String PUBLISH
The action stringpublish
.- See Also:
- Constant Field Values
-
SUBSCRIBE
public static final java.lang.String SUBSCRIBE
The action stringsubscribe
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TopicPermission
public TopicPermission(java.lang.String name, java.lang.String actions)
Defines the authority to publish and/or subscribe to a topic within the EventAdmin service.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 appropriateTopicPermssion
for that topic.- Parameters:
name
- Topic name.actions
-publish
,subscribe
(canonical order).
-
-
Method Detail
-
implies
public boolean implies(java.security.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 targetTopicPermission
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 classjava.security.Permission
- Parameters:
p
- The target permission to interrogate.- Returns:
true
if the specifiedTopicPermission
action is implied by this object;false
otherwise.
-
getActions
public java.lang.String getActions()
Returns the canonical string representation of theTopicPermission
actions.Always returns present
TopicPermission
actions in the following order:publish
,subscribe
.- Specified by:
getActions
in classjava.security.Permission
- Returns:
- Canonical string representation of the
TopicPermission
actions.
-
newPermissionCollection
public java.security.PermissionCollection newPermissionCollection()
Returns a newPermissionCollection
object suitable for storingTopicPermission
objects.- Overrides:
newPermissionCollection
in classjava.security.Permission
- Returns:
- A new
PermissionCollection
object.
-
equals
public boolean equals(java.lang.Object obj)
Determines the equality of twoTopicPermission
objects. This method checks that specifiedTopicPermission
has the same topic name and actions as thisTopicPermission
object.- Specified by:
equals
in classjava.security.Permission
- Parameters:
obj
- The object to test for equality with thisTopicPermission
object.- Returns:
true
ifobj
is aTopicPermission
, and has the same topic name and actions as thisTopicPermission
object;false
otherwise.
-
hashCode
public int hashCode()
Returns the hash code value for this object.- Specified by:
hashCode
in classjava.security.Permission
- Returns:
- A hash code value for this object.
-
-