org.osgi.service.event

Class TopicPermission

java.lang.Object

java.security.Permission

org.osgi.service.event.TopicPermission

All Implemented Interfaces:

Serializable, Guard

public final class TopicPermission
extends 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 and subscribe.

Version:

$Revision$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PUBLISH The action string publish.
static String	SUBSCRIBE The action string subscribe.

Constructor Summary

Constructors

Constructor and Description
TopicPermission(String name, String actions) Defines the authority to publich and/or subscribe to a topic within the EventAdmin service.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Determines the equality of two TopicPermission objects.
String	getActions() Returns the canonical string representation of the TopicPermission actions.
int	hashCode() Returns the hash code value for this object.
boolean	implies(Permission p) Determines if the specified permission is implied by this object.
PermissionCollection	newPermissionCollection() Returns a new PermissionCollection object suitable for storing TopicPermission objects.

Methods inherited from class java.security.Permission

checkGuard, getName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PUBLISH

public static final String PUBLISH

The action string publish.

See Also:

Constant Field Values

SUBSCRIBE

public static final String SUBSCRIBE

The action string subscribe.

See Also:

Constant Field Values

Constructor Detail

TopicPermission

public TopicPermission(String name,
               String actions)

Defines the authority to publich 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 - Topic name.

actions - publish,subscribe (canonical order).

Method Detail

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.