diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java b/bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java index 4b3f76795..e99aec8ba 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java @@ -33,7 +33,8 @@ public abstract class BdfIncomingMessageHook implements IncomingMessageHook { /** * Called once for each incoming message that passes validation. * - * @return whether or not this message should be shared + * @param txn A read-write transaction + * @return Whether or not this message should be shared * @throws DbException Should only be used for real database errors. * If this is thrown, delivery will be attempted again at next startup, * whereas if a FormatException is thrown, the message will be permanently diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactManager.java b/bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactManager.java index 75e61ccc1..dc60fc5c0 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactManager.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactManager.java @@ -164,8 +164,20 @@ public interface ContactManager { interface ContactHook { + /** + * Called when a contact is being added. + * + * @param txn A read-write transaction + * @param c The contact that is being added + */ void addingContact(Transaction txn, Contact c) throws DbException; + /** + * Called when a contact is being removed + * + * @param txn A read-write transaction + * @param c The contact that is being removed + */ void removingContact(Transaction txn, Contact c) throws DbException; } } diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java b/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java index 4abd4b8e3..4bc82918a 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java @@ -102,6 +102,9 @@ public interface LifecycleManager { enum Priority {EARLY, NORMAL, LATE} + /** + * @param txn A read-write transaction + */ void onDatabaseOpened(Transaction txn) throws DbException; } } \ No newline at end of file diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java index 9d14b1a1e..356f54248 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java @@ -11,7 +11,8 @@ public interface IncomingMessageHook { /** * Called once for each incoming message that passes validation. * - * @return whether or not this message should be shared + * @param txn A read-write transaction + * @return Whether or not this message should be shared * @throws DbException Should only be used for real database errors. * If this is thrown, delivery will be attempted again at next startup, * whereas if an InvalidMessageException is thrown, diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/versioning/ClientVersioningManager.java b/bramble-api/src/main/java/org/briarproject/bramble/api/versioning/ClientVersioningManager.java index 76b261d1b..53baed068 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/versioning/ClientVersioningManager.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/versioning/ClientVersioningManager.java @@ -46,7 +46,14 @@ public interface ClientVersioningManager { ClientId clientId, int majorVersion) throws DbException; interface ClientVersioningHook { - + /** + * Called when the visibility of a client with respect to a contact is + * changing. + * + * @param txn A read-write transaction + * @param c The contact affected by the visibility change + * @param v The new visibility of the client + */ void onClientVisibilityChanging(Transaction txn, Contact c, Visibility v) throws DbException; } diff --git a/briar-api/src/main/java/org/briarproject/briar/api/blog/BlogManager.java b/briar-api/src/main/java/org/briarproject/briar/api/blog/BlogManager.java index 27ac12bac..78d4fc354 100644 --- a/briar-api/src/main/java/org/briarproject/briar/api/blog/BlogManager.java +++ b/briar-api/src/main/java/org/briarproject/briar/api/blog/BlogManager.java @@ -124,6 +124,12 @@ public interface BlogManager { void registerRemoveBlogHook(RemoveBlogHook hook); interface RemoveBlogHook { + /** + * Called when a blog is being removed. + * + * @param txn A read-write transaction + * @param b The blog that is being removed + */ void removingBlog(Transaction txn, Blog b) throws DbException; } diff --git a/briar-api/src/main/java/org/briarproject/briar/api/forum/ForumManager.java b/briar-api/src/main/java/org/briarproject/briar/api/forum/ForumManager.java index 75297693a..b8b9f5ca2 100644 --- a/briar-api/src/main/java/org/briarproject/briar/api/forum/ForumManager.java +++ b/briar-api/src/main/java/org/briarproject/briar/api/forum/ForumManager.java @@ -100,6 +100,12 @@ public interface ForumManager { void setReadFlag(GroupId g, MessageId m, boolean read) throws DbException; interface RemoveForumHook { + /** + * Called when a forum is being removed. + * + * @param txn A read-write transaction + * @param f The forum that is being removed + */ void removingForum(Transaction txn, Forum f) throws DbException; } } diff --git a/briar-api/src/main/java/org/briarproject/briar/api/privategroup/PrivateGroupManager.java b/briar-api/src/main/java/org/briarproject/briar/api/privategroup/PrivateGroupManager.java index 6ef9e0259..d47c49f9a 100644 --- a/briar-api/src/main/java/org/briarproject/briar/api/privategroup/PrivateGroupManager.java +++ b/briar-api/src/main/java/org/briarproject/briar/api/privategroup/PrivateGroupManager.java @@ -140,9 +140,22 @@ public interface PrivateGroupManager { @NotNullByDefault interface PrivateGroupHook { + /** + * Called when a member is being added to a private group. + * + * @param txn A read-write transaction + * @param g The ID of the private group + * @param a The member that is being added + */ void addingMember(Transaction txn, GroupId g, Author a) throws DbException; + /** + * Called when a private group is being removed. + * + * @param txn A read-write transaction + * @param g The ID of the private group that is being removed + */ void removingGroup(Transaction txn, GroupId g) throws DbException; }