org.apache.felix.eventadmin.impl.security
Interface TopicPermissions

All Known Implementing Classes:
CacheTopicPermissions

public interface TopicPermissions

A TopicPermission factory. The factory is bound to a specific type (i.e., either PUBLISH or SUBSCRIBE) and subsequently allows to create new permission objects by providing the topic. Note that the created permission objects most likely will be cached and that in case that a permission can not be created due to missing security support by the framework (i.e, security is not supported at all) an instance of java.lang.Object will be returned.

Author:
Felix Project Team

Method Summary
 Object createTopicPermission(String topic)
          This method returns a TopicPermission object for the given topic and the type (i.e., PUBLISH or SUBSCRIBE) of this factory.
 String getType()
          Get the type (i.e., PUBLISH or SUBSCRIBE) of the permission objects that this factory will create.
 

Method Detail

getType

String getType()
Get the type (i.e., PUBLISH or SUBSCRIBE) of the permission objects that this factory will create.

Returns:
The type of the permission objects that this factory will create.
See Also:
TopicPermission.PUBLISH, TopicPermission.SUBSCRIBE

createTopicPermission

Object createTopicPermission(String topic)
This method returns a TopicPermission object for the given topic and the type (i.e., PUBLISH or SUBSCRIBE) of this factory. Note that this methods returns an instance of java.lang.Object in case that a permission could not be created due to missing security support by the framework.

Parameters:
topic - The targeted topic.
Returns:
A TopicPermission for the given topic and the type of this factory or a java.lang.Object in case that the permission could not be created due to missing security support by the framework.
See Also:
TopicPermission, TopicPermission.PUBLISH, TopicPermission.SUBSCRIBE


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.