summaryrefslogtreecommitdiff
path: root/src/leap/soledad/server/interfaces.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/leap/soledad/server/interfaces.py')
-rw-r--r--src/leap/soledad/server/interfaces.py19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/leap/soledad/server/interfaces.py b/src/leap/soledad/server/interfaces.py
index 089111e3..96fa2f94 100644
--- a/src/leap/soledad/server/interfaces.py
+++ b/src/leap/soledad/server/interfaces.py
@@ -44,6 +44,9 @@ class IBlobsBackend(Interface):
:return: A deferred that fires when the blob has been written to the
consumer.
:rtype: twisted.internet.defer.Deferred
+
+ :raise BlobNotFound: Raised (asynchronously) when the blob was not
+ found in the backend.
"""
def write_blob(user, blob_id, producer, namespace=''):
@@ -80,6 +83,9 @@ class IBlobsBackend(Interface):
:return: A deferred that fires when the blob has been deleted.
:rtype: twisted.internet.defer.Deferred
+
+ :raise BlobNotFound: Raised (asynchronously) when the blob was not
+ found in the backend.
"""
def get_blob_size(user, blob_id, namespace=''):
@@ -95,6 +101,9 @@ class IBlobsBackend(Interface):
:return: A deferred that fires with the size of the blob.
:rtype: twisted.internet.defer.Deferred
+
+ :raise BlobNotFound: Raised (asynchronously) when the blob was not
+ found in the backend.
"""
def count(user, namespace=''):
@@ -168,6 +177,9 @@ class IBlobsBackend(Interface):
:return: A deferred that fires with the tag of the blob.
:rtype: twisted.internet.defer.Deferred
+
+ :raise BlobNotFound: Raised (asynchronously) when the blob was not
+ found in the backend.
"""
def get_flags(user, blob_id, namespace=''):
@@ -183,6 +195,9 @@ class IBlobsBackend(Interface):
:return: A deferred that fires with the list of flags for a blob.
:rtype: twisted.internet.defer.Deferred
+
+ :raise BlobNotFound: Raised (asynchronously) when the blob was not
+ found in the backend.
"""
def set_flags(user, blob_id, flags, namespace=''):
@@ -200,4 +215,8 @@ class IBlobsBackend(Interface):
:return: A deferred that fires when the flags have been set.
:rtype: twisted.internet.defer.Deferred
+
+ :raise BlobNotFound: Raised (asynchronously) when the blob was not
+ found in the backend.
+ :raise InvalidFlag: Raised when one of the flags passed is invalid.
"""