OSGi 8.1.0 · org.osgi.service.event.TopicPermission · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final int	ACTION_ALL
private transient int	action_mask The actions mask.
private static final int	ACTION_NONE
private static final int	ACTION_PUBLISH
private static final int	ACTION_SUBSCRIBE
private volatile String	actions The actions in canonical form.
private transient volatile String	prefix prefix if the name is wildcarded.
public static final String	PUBLISH The action string `publish`.
pack-priv static final long	serialVersionUID Hides java.security.Permission.serialVersionUID.
public static final String	SUBSCRIBE The action string `subscribe`.

Access	Constructor and Description
public	TopicPermission(String Topic name. name, String `publish`,`subscribe` (canonical order). actions) Defines the authority to publish and/or subscribe to a topic within the EventAdmin service.
pack-priv	TopicPermission(String class name name, int action mask mask) Package private constructor used by TopicPermissionCollection.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `obj` is a `TopicPermission`, and has the same topic name and actions as this `TopicPermission` object; `false` otherwise. equals(Object The object to test for equality with this `TopicPermission` object. obj) Implements abstract java.security.Permission.equals. Determines the equality of two `TopicPermission` objects.
public String	Returns: Canonical string representation of the `TopicPermission` actions. getActions() Implements abstract java.security.Permission.getActions. Returns the canonical string representation of the `TopicPermission` actions.
pack-priv synchronized int	Returns: Current action mask. getActionsMask() Returns the current action mask.
public int	Returns: A hash code value for this object. hashCode() Implements abstract java.security.Permission.hashCode. Returns the hash code value for this object.
public boolean	Returns: `true` if the specified `TopicPermission` action is implied by this object; `false` otherwise. implies(Permission The target permission to interrogate. p) Implements abstract java.security.Permission.implies. Determines if the specified permission is implied by this object.
public PermissionCollection	Returns: A new `PermissionCollection` object. newPermissionCollection() Overrides java.security.Permission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `TopicPermission` objects.
private static int	Returns: action mask. parseActions(final String Action string. actions) Parse action string into action mask.
private synchronized void	readObject(ObjectInputStream s) readObject is called to restore the state of this permission from a stream.
private synchronized void	setTransients(final int action mask mask) Called by constructors and when deserialized.
private synchronized void	writeObject(ObjectOutputStream s) WriteObject is called to save the state of this permission object to a stream.

Inherited from java.security.Permission:: checkGuard getName toString

Field Detail

ACTION_ALL	back to summary
private static final int ACTION_ALL

action_mask	back to summary
private transient int action_mask The actions mask.

ACTION_NONE	back to summary
private static final int ACTION_NONE

ACTION_PUBLISH	back to summary
private static final int ACTION_PUBLISH

ACTION_SUBSCRIBE	back to summary
private static final int ACTION_SUBSCRIBE

actions	back to summary
private volatile String actions The actions in canonical form.

prefix	back to summary
private transient volatile String prefix prefix if the name is wildcarded.

PUBLISH	back to summary
public static final String PUBLISH The action string `publish`.

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.security.Permission.serialVersionUID.

SUBSCRIBE	back to summary
public static final String SUBSCRIBE The action string `subscribe`.

Constructor Detail

TopicPermission back to summary

TopicPermission	back to summary
public TopicPermission(String name, 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 appropriate `TopicPermssion` for that topic. Parameters name:String Topic name. actions:String `publish`,`subscribe` (canonical order).

public TopicPermission(String name, 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 appropriate TopicPermssion for that topic.

Parameters

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

TopicPermission	back to summary
pack-priv TopicPermission(String name, int mask) Package private constructor used by TopicPermissionCollection. Parameters name:String class name mask:int action mask

TopicPermission

back to summary

pack-priv TopicPermission(String name, int mask)

Package private constructor used by TopicPermissionCollection.

Parameters

name:String: class name
mask:int: action mask

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Implements abstract java.security.Permission.equals. Determines the equality of two `TopicPermission` objects. This method checks that specified `TopicPermission` has the same topic name and actions as this `TopicPermission` object. Parameters obj:Object The object to test for equality with this `TopicPermission` object. Returns:boolean `true` if `obj` is a `TopicPermission`, and has the same topic name and actions as this `TopicPermission` object; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Implements abstract java.security.Permission.equals.

Determines the equality of two TopicPermission objects. This method checks that specified TopicPermission has the same topic name and actions as this TopicPermission object.

Parameters

obj:Object: The object to test for equality with this TopicPermission object.

Returns:boolean

true if obj is a TopicPermission, and has the same topic name and actions as this TopicPermission object; false otherwise.

Annotations

@Override

getActions back to summary

getActions	back to summary
public String getActions() Implements abstract java.security.Permission.getActions. Returns the canonical string representation of the `TopicPermission` actions. Always returns present `TopicPermission` actions in the following order: `publish`,`subscribe`. Returns:String Canonical string representation of the `TopicPermission` actions. Annotations @Override

public String getActions()

Implements abstract java.security.Permission.getActions.

Returns the canonical string representation of the TopicPermission actions.

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

Returns:String

Canonical string representation of the TopicPermission actions.

Annotations

@Override

getActionsMask	back to summary
pack-priv synchronized int getActionsMask() Returns the current action mask. Used by the TopicPermissionCollection class. Returns:int Current action mask.

getActionsMask

back to summary

pack-priv synchronized int getActionsMask()

Returns the current action mask.

Used by the TopicPermissionCollection class.

Returns:int: Current action mask.

hashCode	back to summary
public int hashCode() Implements abstract java.security.Permission.hashCode. Returns the hash code value for this object. Returns:int A hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Implements abstract java.security.Permission.hashCode.

Returns the hash code value for this object.

Returns:int

A hash code value for this object.

Annotations

@Override

implies back to summary

implies	back to summary
public boolean implies(Permission p) Implements abstract java.security.Permission.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 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 Parameters p:Permission The target permission to interrogate. Returns:boolean `true` if the specified `TopicPermission` action is implied by this object; `false` otherwise. Annotations @Override

public boolean implies(Permission p)

Implements abstract java.security.Permission.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 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

Parameters

p:Permission: The target permission to interrogate.

Returns:boolean

true if the specified TopicPermission action is implied by this object; false otherwise.

Annotations

@Override

newPermissionCollection back to summary

newPermissionCollection	back to summary
public PermissionCollection newPermissionCollection() Overrides java.security.Permission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `TopicPermission` objects. Returns:PermissionCollection A new `PermissionCollection` object. Annotations @Override

public PermissionCollection newPermissionCollection()

Overrides java.security.Permission.newPermissionCollection.

Returns a new PermissionCollection object suitable for storing TopicPermission objects.

Returns:PermissionCollection

A new PermissionCollection object.

Annotations

@Override

parseActions	back to summary
private static int parseActions(final String actions) Parse action string into action mask. Parameters actions:String Action string. Returns:int action mask.

parseActions

back to summary

private static int parseActions(final String actions)

Parse action string into action mask.

Parameters

actions:String: Action string.

Returns:int

action mask.

readObject	back to summary
private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException readObject is called to restore the state of this permission from a stream.

setTransients	back to summary
private synchronized void setTransients(final int mask) Called by constructors and when deserialized. Parameters mask:int action mask

setTransients

back to summary

private synchronized void setTransients(final int mask)

Called by constructors and when deserialized.

Parameters

mask:int: action mask

writeObject	back to summary
private synchronized void writeObject(ObjectOutputStream s) throws IOException 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.

public final Class TopicPermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail