tigase.pubsub.api

Interface Logic

public interface Logic

Class responsible for pubsub logic. We should have at least two of them by default: PubSubDefaultLogic, PepDefaultLogic It should be possible to add new implementations. It should be possible to stack logic in similar way to UserRepository is stacked, so that for each service jid and maybe for each node we should be able to pick other logic. If any additional data is need, ie. user roster, instance of class should be passed to classes implementing this interface - maybe new setter methods should be addded to interface Maybe we should added possibility to add events before/after calling logic methods in classes which call methods? Or maybe implementation of this class should fire this events if thay were added?

Author:

andrzej

Method Summary

Methods

Modifier and Type	Method and Description
void	configureNode(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node, tigase.xml.Element config) Configures node of service
void	createNode(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node) Creates node for service
String	getId()
List<tigase.xml.Element>	getNodes(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node) Method returns elements containing info about subnodes to passed node
boolean	isSupported(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node) Method should return true if this node can be handled by this logic instance ie.
String	publish(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node, tigase.xml.Element item) Method adds item to store using logic specific for this service and node but how to send notifications to about publish if item should exists in more than one node?
void	retract(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node, String id) Method removes item from store using logic specific for this service and node
List<tigase.xml.Element>	retrieve(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node, Integer offset, Integer limit) Method retrieves list of items for node starting with offset and no more than limit
List<tigase.xml.Element>	retrieve(tigase.xmpp.JID from, tigase.xmpp.BareJID service, String node, String id) Method retrieves item with supplied id from store using specific logic for this service and node
void	setProperties(Map<String,Object> props) Method sets configuration

Method Detail

configureNode

void configureNode(tigase.xmpp.JID from,
                 tigase.xmpp.BareJID service,
                 String node,
                 tigase.xml.Element config)
                   throws RepositoryException

Configures node of service

Parameters:

from -

service -

node -

config -

Throws:

RepositoryException

createNode

void createNode(tigase.xmpp.JID from,
              tigase.xmpp.BareJID service,
              String node)
                throws RepositoryException

Creates node for service

Parameters:

from -

service -

node -

Throws:

RepositoryException

getId

String getId()

getNodes

List<tigase.xml.Element> getNodes(tigase.xmpp.JID from,
                                tigase.xmpp.BareJID service,
                                String node)
                                  throws RepositoryException

Method returns elements containing info about subnodes to passed node

Parameters:

from -

service -

node - - parent node, can be null for root node

Returns:

Throws:

RepositoryException

isSupported

boolean isSupported(tigase.xmpp.JID from,
                  tigase.xmpp.BareJID service,
                  String node)

Method should return true if this node can be handled by this logic instance ie. PEP could have multiple logic instances handling diffrent nodes?

Parameters:

from -

service -

node -

Returns:

publish

String publish(tigase.xmpp.JID from,
             tigase.xmpp.BareJID service,
             String node,
             tigase.xml.Element item)
               throws RepositoryException

Method adds item to store using logic specific for this service and node but how to send notifications to about publish if item should exists in more than one node?

Parameters:

from - - source jid of stanza

service -

node -

item -

Returns:

Throws:

RepositoryException

retract

void retract(tigase.xmpp.JID from,
           tigase.xmpp.BareJID service,
           String node,
           String id)
             throws RepositoryException

Method removes item from store using logic specific for this service and node

Parameters:

from - - source jid of stanza

service -

node -

id -

Throws:

RepositoryException

retrieve

List<tigase.xml.Element> retrieve(tigase.xmpp.JID from,
                                tigase.xmpp.BareJID service,
                                String node,
                                Integer offset,
                                Integer limit)
                                  throws RepositoryException

Method retrieves list of items for node starting with offset and no more than limit

Parameters:

from - - source jid of stanza

service -

node -

offset - - offset of items to return, can be null

limit - - max number of items to return, can be null

Returns:

Throws:

RepositoryException

retrieve

List<tigase.xml.Element> retrieve(tigase.xmpp.JID from,
                                tigase.xmpp.BareJID service,
                                String node,
                                String id)
                                  throws RepositoryException

Method retrieves item with supplied id from store using specific logic for this service and node

Parameters:

from - - source jid of stanza

service -

node -

id -

Returns:

Throws:

RepositoryException

setProperties

void setProperties(Map<String,Object> props)

Method sets configuration

Parameters:

props -