libervia-pubsub: idavoll/iidavoll.py annotate

annotate idavoll/iidavoll.py @ 207:43a4d0d6c076

Release Idavoll 0.8.0.

author	Ralph Meijer <ralphm@ik.nu>
date	Tue, 05 Aug 2008 18:23:45 +0000
parents	274a45d2a5ab
children

rev	line source
189 c61034369463 Released Idavoll 0.7.0. Ralph Meijer <ralphm@ik.nu> parents: 173 diff changeset	1 # Copyright (c) 2003-2008 Ralph Meijer
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	2 # See LICENSE for details.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	3
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	4 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	5 Interfaces for idavoll.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	6 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	7
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	8 from zope.interface import Attribute, Interface
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	9
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	10 class IBackendService(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	11 """ Interface to a backend service of a pubsub service. """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	12
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	13
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	14 def __init__(storage):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	15 """
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	16 @param storage: Object providing L{IStorage}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	17 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	18
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	19
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	20 def supportsPublisherAffiliation():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	21 """ Reports if the backend supports the publisher affiliation.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	22
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	23 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	24 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	25
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	26
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	27 def supportsOutcastAffiliation():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	28 """ Reports if the backend supports the publisher affiliation.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	29
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	30 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	31 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	32
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	33
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	34 def supportsPersistentItems():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	35 """ Reports if the backend supports persistent items.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	36
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	37 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	38 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	39
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	40
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	41 def getNodeType(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	42 """ Return type of a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	43
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	44 @return: a deferred that returns either 'leaf' or 'collection'
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	45 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	46
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	47
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	48 def getNodes():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	49 """ Returns list of all nodes.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	50
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	51 @return: a deferred that returns a C{list} of node ids.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	52 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	53
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	54
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	55 def getNodeMetaData(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	56 """ Return meta data for a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	57
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	58 @return: a deferred that returns a C{list} of C{dict}s with the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	59 metadata.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	60 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	61
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	62
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	63 def createNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	64 """ Create a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	65
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	66 @return: a deferred that fires when the node has been created.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	67 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	68
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	69
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	70 def registerPreDelete(preDeleteFn):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	71 """ Register a callback that is called just before a node deletion.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	72
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	73 The function C{preDeletedFn} is added to a list of functions to be
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	74 called just before deletion of a node. The callback C{preDeleteFn} is
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	75 called with the C{nodeIdentifier} that is about to be deleted and
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	76 should return a deferred that returns a list of deferreds that are to
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	77 be fired after deletion. The backend collects the lists from all these
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	78 callbacks before actually deleting the node in question. After
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	79 deletion all collected deferreds are fired to do post-processing.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	80
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	81 The idea is that you want to be able to collect data from the node
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	82 before deleting it, for example to get a list of subscribers that have
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	83 to be notified after the node has been deleted. To do this,
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	84 C{preDeleteFn} fetches the subscriber list and passes this list to a
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	85 callback attached to a deferred that it sets up. This deferred is
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	86 returned in the list of deferreds.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	87 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	88
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	89
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	90 def deleteNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	91 """ Delete a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	92
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	93 @return: a deferred that fires when the node has been deleted.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	94 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	95
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	96
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	97 def purgeNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	98 """ Removes all items in node from persistent storage """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	99
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	100
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	101 def subscribe(nodeIdentifier, subscriber, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	102 """ Request the subscription of an entity to a pubsub node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	103
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	104 Depending on the node's configuration and possible business rules, the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	105 C{subscriber} is added to the list of subscriptions of the node with id
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	106 C{nodeIdentifier}. The C{subscriber} might be different from the
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	107 C{requestor}, and if the C{requestor} is not allowed to subscribe this
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	108 entity an exception should be raised.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	109
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	110 @return: a deferred that returns the subscription state
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	111 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	112
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	113
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	114 def unsubscribe(nodeIdentifier, subscriber, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	115 """ Cancel the subscription of an entity to a pubsub node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	116
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	117 The subscription of C{subscriber} is removed from the list of
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	118 subscriptions of the node with id C{nodeIdentifier}. If the
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	119 C{requestor} is not allowed to unsubscribe C{subscriber}, an an
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	120 exception should be raised.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	121
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	122 @return: a deferred that fires when unsubscription is complete.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	123 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	124
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	125
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	126 def getSubscribers(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	127 """ Get node subscriber list.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	128
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	129 @return: a deferred that fires with the list of subscribers.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	130 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	131
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	132
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	133 def getSubscriptions(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	134 """ Report the list of current subscriptions with this pubsub service.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	135
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	136 Report the list of the current subscriptions with all nodes within this
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	137 pubsub service, for the C{entity}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	138
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	139 @return: a deferred that returns the list of all current subscriptions
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	140 as tuples C{(nodeIdentifier, subscriber, subscription)}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	141 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	142
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	143
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	144 def getAffiliations(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	145 """ Report the list of current affiliations with this pubsub service.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	146
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	147 Report the list of the current affiliations with all nodes within this
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	148 pubsub service, for the C{entity}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	149
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	150 @return: a deferred that returns the list of all current affiliations
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	151 as tuples C{(nodeIdentifier, affiliation)}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	152 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	153
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	154
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	155 def publish(nodeIdentifier, items, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	156 """ Publish items to a pubsub node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	157
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	158 @return: a deferred that fires when the items have been published.
173 246911bcb699 Make node type part of node configuration. Ralph Meijer <ralphm@ik.nu> parents: 167 diff changeset	159 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	160 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	161
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	162
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	163 def registerNotifier(observerfn, args, *kwargs):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	164 """ Register callback which is called for notification. """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	165
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	166
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	167 def getNotifications(nodeIdentifier, items):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	168 """
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	169 Get notification list.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	170
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	171 This method is called to discover which entities should receive
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	172 notifications for the given items that have just been published to the
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	173 given node.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	174
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	175 The notification list contains tuples (subscriber, subscriptions,
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	176 items) to result in one notification per tuple: the given subscriptions
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	177 yielded the given items to be notified to this subscriber. This
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	178 structure is needed allow for letting the subscriber know which
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	179 subscriptions yielded which notifications, while catering for
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	180 collection nodes and content-based subscriptions.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	181
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	182 To minimize the amount of notifications per entity, implementers
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	183 should take care that if all items in C{items} were yielded
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	184 by the same set of subscriptions, exactly one tuple is for this
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	185 subscriber is returned, so that the subscriber would get exactly one
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	186 notification. Alternatively, one tuple per subscription combination.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	187
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	188 @param nodeIdentifier: The identifier of the node the items were
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	189 published to.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	190 @type nodeIdentifier: C{unicode}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	191 @param items: The list of published items as
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	192 L{Element<twisted.words.xish.domish.Element>}s.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	193 @type items: C{list}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	194 @return: The notification list as tuples of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	195 (L{JID<twisted.words.protocols.jabber.jid.JID>},
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	196 C{list} of L{Subscription<wokkel.pubsub.Subscription>},
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	197 C{list} of L{Element<twisted.words.xish.domish.Element>}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	198 @rtype: C{list}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	199 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	200
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	201
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	202 def getItems(nodeIdentifier, requestor, maxItems=None, itemIdentifiers=[]):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	203 """ Retrieve items from persistent storage
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	204
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	205 If C{maxItems} is given, return the C{maxItems} last published
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	206 items, else if C{itemIdentifiers} is not empty, return the items
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	207 requested. If neither is given, return all items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	208
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	209 @return: a deferred that returns the requested items
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	210 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	211
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	212
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	213 def retractItem(nodeIdentifier, itemIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	214 """ Removes item in node from persistent storage """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	215
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	216
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	217
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	218 class IStorage(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	219 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	220 Storage interface.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	221 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	222
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	223
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	224 def getNode(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	225 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	226 Get Node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	227
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	228 @param nodeIdentifier: NodeID of the desired node.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	229 @type nodeIdentifier: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	230 @return: deferred that returns a L{INode} providing object.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	231 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	232
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	233
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	234 def getNodeIds():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	235 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	236 Return all NodeIDs.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	237
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	238 @return: deferred that returns a list of NodeIDs (C{unicode}).
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	239 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	240
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	241
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	242 def createNode(nodeIdentifier, owner, config):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	243 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	244 Create new node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	245
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	246 The implementation should make sure, the passed owner JID is stripped
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	247 of the resource (e.g. using C{owner.userhostJID()}). The passed config
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	248 is expected to have values for the fields returned by
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	249 L{getDefaultConfiguration}, as well as a value for
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	250 C{'pubsub#node_type'}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	251
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	252 @param nodeIdentifier: NodeID of the new node.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	253 @type nodeIdentifier: C{unicode}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	254 @param owner: JID of the new nodes's owner.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	255 @type owner: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	256 @param config: Node configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	257 @type config: C{dict}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	258 @return: deferred that fires on creation.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	259 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	260
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	261
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	262 def deleteNode(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	263 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	264 Delete a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	265
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	266 @param nodeIdentifier: NodeID of the new node.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	267 @type nodeIdentifier: C{unicode}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	268 @return: deferred that fires on deletion.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	269 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	270
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	271
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	272 def getAffiliations(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	273 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	274 Get all affiliations for entity.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	275
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	276 The implementation should make sure, the passed owner JID is stripped
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	277 of the resource (e.g. using C{owner.userhostJID()}).
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	278
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	279 @param entity: JID of the entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	280 @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	281 @return: deferred that returns a C{list} of tuples of the form
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	282 C{(nodeIdentifier, affiliation)}, where C{nodeIdentifier} is
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	283 of the type L{unicode} and C{affiliation} is one of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	284 C{'owner'}, C{'publisher'} and C{'outcast'}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	285 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	286
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	287
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	288 def getSubscriptions(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	289 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	290 Get all subscriptions for an entity.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	291
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	292 The implementation should make sure, the passed owner JID is stripped
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	293 of the resource (e.g. using C{owner.userhostJID()}).
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	294
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	295 @param entity: JID of the entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	296 @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	297 @return: deferred that returns a C{list} of tuples of the form
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	298 C{(nodeIdentifier, subscriber, state)}, where
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	299 C{nodeIdentifier} is of the type C{unicode}, C{subscriber} of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	300 the type J{JID<twisted.words.protocols.jabber.jid.JID>}, and
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	301 C{state} is C{'subscribed'}, C{'pending'} or
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	302 C{'unconfigured'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	303 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	304
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	305
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	306 def getDefaultConfiguration(nodeType):
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	307 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	308 Get the default configuration for the given node type.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	309
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	310 @param nodeType: Either C{'leaf'} or C{'collection'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	311 @type nodeType: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	312 @return: The default configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	313 @rtype: C{dict}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	314 @raises: L{idavoll.error.NoCollections} if collections are not
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	315 supported.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	316 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	317
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	318
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	319
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	320 class INode(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	321 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	322 Interface to the class of objects that represent nodes.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	323 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	324
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	325 nodeType = Attribute("""The type of this node. One of {'leaf'},
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	326 {'collection'}.""")
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	327 nodeIdentifier = Attribute("""The node identifer of this node""")
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	328
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	329
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	330 def getType():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	331 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	332 Get node's type.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	333
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	334 @return: C{'leaf'} or C{'collection'}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	335 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	336
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	337
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	338 def getConfiguration():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	339 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	340 Get node's configuration.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	341
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	342 The configuration must at least have two options:
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	343 C{pubsub#persist_items}, and C{pubsub#deliver_payloads}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	344
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	345 @return: C{dict} of configuration options.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	346 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	347
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	348
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	349 def getMetaData():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	350 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	351 Get node's meta data.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	352
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	353 The meta data must be a superset of the configuration options, and
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	354 also at least should have a C{pubsub#node_type} entry.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	355
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	356 @return: C{dict} of meta data.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	357 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	358
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	359
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	360 def setConfiguration(options):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	361 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	362 Set node's configuration.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	363
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	364 The elements of {options} will set the new values for those
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	365 configuration items. This means that only changing items have to
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	366 be given.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	367
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	368 @param options: a dictionary of configuration options.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	369 @returns: a deferred that fires upon success.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	370 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	371
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	372
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	373 def getAffiliation(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	374 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	375 Get affiliation of entity with this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	376
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	377 @param entity: JID of entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	378 @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	379 @return: deferred that returns C{'owner'}, C{'publisher'}, C{'outcast'}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	380 or C{None}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	381 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	382
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	383
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	384 def getSubscription(subscriber):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	385 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	386 Get subscription to this node of subscriber.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	387
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	388 @param subscriber: JID of the new subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	389 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	390 @return: deferred that returns the subscription state (C{'subscribed'},
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	391 C{'pending'} or C{None}).
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	392 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	393
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	394
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	395 def getSubscriptions(state=None):
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	396 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	397 Get list of subscriptions to this node.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	398
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	399 The optional C{state} argument filters the subscriptions to their
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	400 state.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	401
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	402 @param state: Subscription state filter. One of C{'subscribed'},
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	403 C{'pending'}, C{'unconfigured'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	404 @type state: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	405 @return: a deferred that returns a C{list} of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	406 L{wokkel.pubsub.Subscription}s.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	407 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	408
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	409
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	410 def addSubscription(subscriber, state, config):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	411 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	412 Add new subscription to this node with given state.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	413
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	414 @param subscriber: JID of the new subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	415 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	416 @param state: C{'subscribed'} or C{'pending'}
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	417 @type state: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	418 @param config: Subscription configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	419 @param config: C{dict}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	420 @return: deferred that fires on subscription.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	421 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	422
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	423
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	424 def removeSubscription(subscriber):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	425 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	426 Remove subscription to this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	427
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	428 @param subscriber: JID of the subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	429 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	430 @return: deferred that fires on removal.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	431 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	432
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	433
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	434 def isSubscribed(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	435 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	436 Returns whether entity has any subscription to this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	437
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	438 Only returns C{True} when the subscription state (if present) is
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	439 C{'subscribed'} for any subscription that matches the bare JID.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	440
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	441 @param subscriber: bare JID of the subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	442 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	443 @return: deferred that returns a C{bool}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	444 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	445
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	446
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	447 def getAffiliations():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	448 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	449 Get affiliations of entities with this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	450
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	451 @return: deferred that returns a C{list} of tuples (jid, affiliation),
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	452 where jid is a L(JID<twisted.words.protocols.jabber.jid.JID>)
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	453 and affiliation is one of C{'owner'},
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	454 C{'publisher'}, C{'outcast'}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	455 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	456
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	457
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	458
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	459 class ILeafNode(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	460 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	461 Interface to the class of objects that represent leaf nodes.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	462 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	463
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	464 def storeItems(items, publisher):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	465 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	466 Store items in persistent storage for later retrieval.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	467
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	468 @param items: The list of items to be stored. Each item is the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	469 L{domish} representation of the XML fragment as defined
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	470 for C{<item/>} in the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	471 C{http://jabber.org/protocol/pubsub} namespace.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	472 @type items: C{list} of {domish.Element}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	473 @param publisher: JID of the publishing entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	474 @type publisher: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	475 @return: deferred that fires upon success.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	476 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	477
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	478
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	479 def removeItems(itemIdentifiers):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	480 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	481 Remove items by id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	482
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	483 @param itemIdentifiers: C{list} of item ids.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	484 @return: deferred that fires with a C{list} of ids of the items that
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	485 were deleted
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	486 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	487
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	488
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	489 def getItems(maxItems=None):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	490 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	491 Get items.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	492
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	493 If C{maxItems} is not given, all items in the node are returned,
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	494 just like C{getItemsById}. Otherwise, C{maxItems} limits
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	495 the returned items to a maximum of that number of most recently
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	496 published items.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	497
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	498 @param maxItems: if given, a natural number (>0) that limits the
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	499 returned number of items.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	500 @return: deferred that fires with a C{list} of found items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	501 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	502
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	503
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	504 def getItemsById(itemIdentifiers):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	505 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	506 Get items by item id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	507
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	508 Each item in the returned list is a unicode string that
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	509 represent the XML of the item as it was published, including the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	510 item wrapper with item id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	511
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	512 @param itemIdentifiers: C{list} of item ids.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	513 @return: deferred that fires with a C{list} of found items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	514 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	515
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	516
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	517 def purge():
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	518 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	519 Purge node of all items in persistent storage.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	520
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	521 @return: deferred that fires when the node has been purged.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	522 """
204 b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	523
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	524
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	525
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	526 class IGatewayStorage(Interface):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	527
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	528 def addCallback(service, nodeIdentifier, callback):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	529 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	530 Register a callback URI.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	531
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	532 The registered HTTP callback URI will have an Atom Entry documented
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	533 POSTed to it upon receiving a notification for the given pubsub node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	534
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	535 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	536 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	537 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	538 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	539 @param callback: The callback URI to be registered.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	540 @type callback: C{str}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	541 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	542 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	543
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	544 def removeCallback(service, nodeIdentifier, callback):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	545 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	546 Remove a registered callback URI.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	547
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	548 The returned deferred will fire with a boolean that signals wether or
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	549 not this was the last callback unregistered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	550
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	551 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	552 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	553 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	554 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	555 @param callback: The callback URI to be unregistered.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	556 @type callback: C{str}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	557 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	558 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	559
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	560 def getCallbacks(service, nodeIdentifier):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	561 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	562 Get the callbacks registered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	563
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	564 Returns a deferred that fires with the set of HTTP callback URIs
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	565 registered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	566
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	567 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	568 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	569 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	570 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	571 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	572 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	573
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	574
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	575 def hasCallbacks(service, nodeIdentifier):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	576 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	577 Return wether there are callbacks registered for a node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	578
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	579 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	580 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	581 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	582 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	583 @returns: Deferred that fires with a boolean.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	584 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	585 """

Mercurial > libervia-pubsub

annotate idavoll/iidavoll.py @ 207:43a4d0d6c076