You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by md...@apache.org on 2013/07/08 16:27:14 UTC
svn commit: r1500761 -
/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/PostCommitHook.java
Author: mduerig
Date: Mon Jul 8 14:27:14 2013
New Revision: 1500761
URL: http://svn.apache.org/r1500761
Log:
OAK-144 Implement observation
Javadoc
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/PostCommitHook.java
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/PostCommitHook.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/PostCommitHook.java?rev=1500761&r1=1500760&r2=1500761&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/PostCommitHook.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/PostCommitHook.java Mon Jul 8 14:27:14 2013
@@ -24,7 +24,11 @@ import javax.annotation.Nonnull;
import org.apache.jackrabbit.oak.spi.state.NodeState;
/**
- * TODO unify with either Observer or CommitHook
+ * Extension point for observing content changes of an Oak
+ * {@link org.apache.jackrabbit.oak.api.Root}. Content changes are
+ * reported by passing the <em>before</em> and <em>after</em> state of the content
+ * tree to the {@link #contentChanged(NodeState, NodeState)} callback
+ * method.
*/
public interface PostCommitHook {
PostCommitHook EMPTY = new PostCommitHook() {
@@ -32,5 +36,15 @@ public interface PostCommitHook {
public void contentChanged(@Nonnull NodeState before, @Nonnull NodeState after) { }
};
+ /**
+ * Observes a content change on the associated {@link org.apache.jackrabbit.oak.api.Root}.
+ * <p>
+ * Post-commit hooks are executed synchronously within the context of
+ * a repository instance, so to prevent delaying access to latest changes
+ * the after-commit hooks should avoid any potentially blocking operations.
+ *
+ * @param before content tree before the commit
+ * @param after content tree after the commit
+ */
void contentChanged(@Nonnull NodeState before, @Nonnull NodeState after);
}