libervia-pubsub: sat_pubsub/iidavoll.py annotate

annotate sat_pubsub/iidavoll.py @ 233:564ae55219e1

sublicensed under AGPL V3

author	Goffi <goffi@goffi.org>
date	Thu, 17 May 2012 01:48:39 +0200
parents	923281d4c5bc
children	64f780413b82

rev	line source
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	1 #!/usr/bin/python
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	2 #-- coding: utf-8 --
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	3
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	4 """
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	5 Copyright (c) 2003-2009 Ralph Meijer
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	6 Copyright (c) 2012 Jérôme Poisson
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	7
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	8
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	9 This program is free software: you can redistribute it and/or modify
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	10 it under the terms of the GNU Affero General Public License as published by
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	11 the Free Software Foundation, either version 3 of the License, or
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	12 (at your option) any later version.
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	13
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	14 This program is distributed in the hope that it will be useful,
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	15 but WITHOUT ANY WARRANTY; without even the implied warranty of
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	17 GNU Affero General Public License for more details.
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	18
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	19 You should have received a copy of the GNU Affero General Public License
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	20 along with this program. If not, see <http://www.gnu.org/licenses/>.
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	21 --
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	22
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	23 This program is based on Idavoll (http://idavoll.ik.nu/),
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	24 originaly written by Ralph Meijer (http://ralphm.net/blog/)
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	25 It is sublicensed under AGPL v3 (or any later version) as allowed by the original
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	26 license.
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	27
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	28 --
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	29
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	30 Here is a copy of the original license:
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	31
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	32 Copyright (c) 2003-2009 Ralph Meijer
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	33
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	34 Permission is hereby granted, free of charge, to any person obtaining
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	35 a copy of this software and associated documentation files (the
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	36 "Software"), to deal in the Software without restriction, including
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	37 without limitation the rights to use, copy, modify, merge, publish,
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	38 distribute, sublicense, and/or sell copies of the Software, and to
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	39 permit persons to whom the Software is furnished to do so, subject to
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	40 the following conditions:
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	41
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	42 The above copyright notice and this permission notice shall be
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	43 included in all copies or substantial portions of the Software.
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	44
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	45 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	46 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	47 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	48 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	49 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	50 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	51 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	52
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	53 """
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	54
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	55 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	56 Interfaces for idavoll.
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
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	59 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	60
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	61 class IBackendService(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	62 """ 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	63
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	64
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	65 def __init__(storage):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	66 """
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	67 @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	68 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	69
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	70
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	71 def supportsPublisherAffiliation():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	72 """ 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	73
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	74 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	75 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	76
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	77
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	78 def supportsOutcastAffiliation():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	79 """ 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	80
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	81 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	82 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	83
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	84
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	85 def supportsPersistentItems():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	86 """ 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	87
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	88 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	89 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	90
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	91
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	92 def getNodeType(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	93 """ 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	94
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	95 @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	96 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	97
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	98
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	99 def getNodes():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	100 """ 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	101
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	102 @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	103 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	104
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	105
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	106 def getNodeMetaData(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	107 """ 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	108
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	109 @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	110 metadata.
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 createNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	115 """ Create a 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 @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	118 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	119
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	120
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	121 def registerPreDelete(preDeleteFn):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	122 """ 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	123
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	124 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	125 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	126 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	127 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	128 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	129 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	130 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	131
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	132 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	133 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	134 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	135 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	136 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	137 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	138 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	139
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	140
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	141 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	142 """ Delete a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	143
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	144 @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	145 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	146
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	147
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	148 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	149 """ 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	150
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	151
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	152 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	153 """ 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	154
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	155 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	156 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	157 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	158 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	159 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	160
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	161 @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	162 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	163
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	164
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	165 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	166 """ 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	167
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	168 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	169 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	170 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	171 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	172
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	173 @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	174 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	175
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	176
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	177 def getSubscribers(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	178 """ Get node subscriber list.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	179
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	180 @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	181 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	182
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	183
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	184 def getSubscriptions(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	185 """ 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	186
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	187 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	188 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	189
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	190 @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	191 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	192 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	193
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	194
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	195 def getAffiliations(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	196 """ 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	197
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	198 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	199 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	200
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	201 @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	202 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	203 """
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
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	206 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	207 """ 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	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 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	210 @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	211 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	212
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	213
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	214 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	215 """ 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	216
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	217
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	218 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	219 """
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	220 Get notification list.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	221
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	222 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	223 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	224 given node.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	225
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	226 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	227 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	228 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	229 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	230 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	231 collection nodes and content-based subscriptions.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	232
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	233 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	234 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	235 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	236 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	237 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	238
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	239 @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	240 published to.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	241 @type nodeIdentifier: C{unicode}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	242 @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	243 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	244 @type items: C{list}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	245 @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	246 (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	247 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	248 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	249 @rtype: C{list}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	250 """
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
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	253 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	254 """ 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	255
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	256 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	257 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	258 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	259
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	260 @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	261 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	262
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	263
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	264 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	265 """ 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	266
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	267
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	268
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	269 class IStorage(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	270 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	271 Storage interface.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	272 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	273
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	274
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	275 def getNode(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	276 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	277 Get Node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	278
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	279 @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	280 @type nodeIdentifier: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	281 @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	282 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	283
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	284
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	285 def getNodeIds():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	286 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	287 Return all NodeIDs.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	288
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	289 @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	290 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	291
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	292
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	293 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	294 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	295 Create new node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	296
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	297 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	298 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	299 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	300 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	301 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	302
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	303 @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	304 @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	305 @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	306 @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	307 @param config: Node configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	308 @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	309 @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	310 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	311
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	312
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	313 def deleteNode(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	314 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	315 Delete a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	316
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	317 @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	318 @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	319 @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	320 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	321
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	322
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	323 def getAffiliations(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	324 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	325 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	326
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	327 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	328 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	329
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	330 @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	331 @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	332 @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	333 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	334 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	335 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	336 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	337
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	338
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	339 def getSubscriptions(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	340 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	341 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	342
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	343 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	344 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	345
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	346 @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	347 @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	348 @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	349 C{(nodeIdentifier, subscriber, state)}, where
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	350 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	351 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	352 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	353 C{'unconfigured'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	354 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	355
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	356
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	357 def getDefaultConfiguration(nodeType):
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	358 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	359 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	360
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	361 @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	362 @type nodeType: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	363 @return: The default configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	364 @rtype: C{dict}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	365 @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	366 supported.
167 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
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	369
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	370
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	371 class INode(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	372 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	373 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	374 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	375
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	376 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	377 {'collection'}.""")
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	378 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	379
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	380
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	381 def getType():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	382 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	383 Get node's type.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	384
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	385 @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	386 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	387
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	388
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	389 def getConfiguration():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	390 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	391 Get node's configuration.
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 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	394 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	395
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	396 @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	397 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	398
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	399
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	400 def getMetaData():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	401 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	402 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	403
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	404 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	405 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	406
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	407 @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	408 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	409
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	410
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	411 def setConfiguration(options):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	412 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	413 Set node's configuration.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	414
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	415 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	416 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	417 be given.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	418
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	419 @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	420 @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	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 getAffiliation(entity):
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 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	427
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	428 @param entity: JID of entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	429 @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	430 @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	431 or C{None}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	432 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	433
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	434
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	435 def getSubscription(subscriber):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	436 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	437 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	438
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	439 @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	440 @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	441 @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	442 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	443 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	444
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	445
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	446 def getSubscriptions(state=None):
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	447 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	448 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	449
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	450 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	451 state.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	452
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	453 @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	454 C{'pending'}, C{'unconfigured'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	455 @type state: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	456 @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	457 L{wokkel.pubsub.Subscription}s.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	458 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	459
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	460
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	461 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	462 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	463 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	464
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	465 @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	466 @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	467 @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	468 @type state: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	469 @param config: Subscription configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	470 @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	471 @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	472 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	473
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	474
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	475 def removeSubscription(subscriber):
167 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 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	478
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	479 @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	480 @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	481 @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	482 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	483
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	484
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	485 def isSubscribed(entity):
167 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 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	488
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	489 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	490 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	491
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	492 @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	493 @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	494 @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	495 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	496
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	497
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	498 def getAffiliations():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	499 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	500 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	501
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	502 @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	503 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	504 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	505 C{'publisher'}, C{'outcast'}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	506 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	507
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	508
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	509
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	510 class ILeafNode(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	511 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	512 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	513 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	514
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	515 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	516 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	517 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	518
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	519 @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	520 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	521 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	522 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	523 @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	524 @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	525 @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	526 @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	527 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	528
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	529
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	530 def removeItems(itemIdentifiers):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	531 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	532 Remove items by id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	533
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	534 @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	535 @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	536 were deleted
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	537 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	538
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	539
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	540 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	541 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	542 Get items.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	543
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	544 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	545 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	546 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	547 published items.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	548
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	549 @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	550 returned number of items.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	551 @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	552 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	553
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	554
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	555 def getItemsById(itemIdentifiers):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	556 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	557 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	558
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	559 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	560 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	561 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	562
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	563 @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	564 @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	565 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	566
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	567
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	568 def purge():
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	569 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	570 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	571
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	572 @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	573 """
204 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
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 class IGatewayStorage(Interface):
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 def addCallback(service, nodeIdentifier, callback):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	580 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	581 Register a callback URI.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	582
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	583 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	584 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	585
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	586 @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	587 @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	588 @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	589 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	590 @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	591 @type callback: C{str}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	592 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	593 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	594
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	595 def removeCallback(service, nodeIdentifier, callback):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	596 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	597 Remove a registered callback URI.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	598
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	599 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	600 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	601
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	602 @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	603 @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	604 @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	605 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	606 @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	607 @type callback: C{str}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	608 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	609 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	610
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	611 def getCallbacks(service, nodeIdentifier):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	612 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	613 Get the callbacks registered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	614
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	615 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	616 registered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	617
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	618 @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	619 @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	620 @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	621 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	622 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	623 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	624
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	625
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	626 def hasCallbacks(service, nodeIdentifier):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	627 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	628 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	629
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	630 @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	631 @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	632 @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	633 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	634 @returns: Deferred that fires with a boolean.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	635 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	636 """

Mercurial > libervia-pubsub

annotate sat_pubsub/iidavoll.py @ 233:564ae55219e1