Class TopicPermission
- All Implemented Interfaces:
Serializable
,Guard
A topic is a slash-separated string that defines a topic.
For example:
org/osgi/service/foo/FooEvent/ACTION
TopicPermission
has two actions: publish
and
subscribe
.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private int
The actions mask.private static final int
private static final int
private static final int
private String
The actions in canonical form.private String
prefix if the name is wildcarded.static final String
The action stringpublish
.(package private) static final long
static final String
The action stringsubscribe
. -
Constructor Summary
ConstructorsConstructorDescriptionTopicPermission
(String name, int mask) Package private constructor used by TopicPermissionCollection.TopicPermission
(String name, String actions) Defines the authority to publish and/or subscribe to a topic within the EventAdmin service. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines the equality of twoTopicPermission
objects.Returns the canonical string representation of theTopicPermission
actions.(package private) int
Returns the current action mask.int
hashCode()
Returns the hash code value for this object.boolean
Determines if the specified permission is implied by this object.Returns a newPermissionCollection
object suitable for storingTopicPermission
objects.private static int
parseActions
(String actions) Parse action string into action mask.private void
readObject is called to restore the state of this permission from a stream.private void
setTransients
(int mask) Called by constructors and when deserialized.private void
WriteObject is called to save the state of this permission object to a stream.Methods inherited from class java.security.Permission
checkGuard, getName, toString
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
PUBLISH
The action stringpublish
.- See Also:
-
SUBSCRIBE
The action stringsubscribe
.- See Also:
-
ACTION_PUBLISH
private static final int ACTION_PUBLISH- See Also:
-
ACTION_SUBSCRIBE
private static final int ACTION_SUBSCRIBE- See Also:
-
ACTION_ALL
private static final int ACTION_ALL- See Also:
-
ACTION_NONE
private static final int ACTION_NONE- See Also:
-
action_mask
private transient int action_maskThe actions mask. -
prefix
prefix if the name is wildcarded. -
actions
The actions in canonical form.
-
-
Constructor Details
-
TopicPermission
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).
-
TopicPermission
TopicPermission(String name, int mask) Package private constructor used by TopicPermissionCollection.- Parameters:
name
- class namemask
- action mask
-
-
Method Details
-
setTransients
private void setTransients(int mask) Called by constructors and when deserialized.- Parameters:
name
- topic namemask
- action mask
-
getActionsMask
int getActionsMask()Returns the current action mask.Used by the TopicPermissionCollection class.
- Returns:
- Current action mask.
-
parseActions
Parse action string into action mask.- Parameters:
actions
- Action string.- Returns:
- action mask.
-
implies
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 classPermission
- Parameters:
p
- The target permission to interrogate.- Returns:
true
if the specifiedTopicPermission
action is implied by this object;false
otherwise.
-
getActions
Returns the canonical string representation of theTopicPermission
actions.Always returns present
TopicPermission
actions in the following order:publish
,subscribe
.- Specified by:
getActions
in classPermission
- Returns:
- Canonical string representation of the
TopicPermission
actions.
-
newPermissionCollection
Returns a newPermissionCollection
object suitable for storingTopicPermission
objects.- Overrides:
newPermissionCollection
in classPermission
- Returns:
- A new
PermissionCollection
object.
-
equals
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 classPermission
- 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 classPermission
- Returns:
- A hash code value for this object.
-
writeObject
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:
IOException
-
readObject
readObject is called to restore the state of this permission from a stream.- Throws:
IOException
ClassNotFoundException
-