Author: mduerig
Date: Tue Nov 26 10:41:05 2013
New Revision: 1545603
URL: http://svn.apache.org/r1545603
Log:
OAK-1133: Observation listener PLUS
Extract FilterProvider interface to prepare injection of custom filters (WIP)
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/ChangeProcessor.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/JcrFilterProvider.java
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/observation/ObservationManagerImpl.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/ChangeProcessor.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/ChangeProcessor.java?rev=1545603&r1=1545602&r2=1545603&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/ChangeProcessor.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/ChangeProcessor.java
Tue Nov 26 10:41:05 2013
@@ -39,6 +39,7 @@ import org.apache.jackrabbit.oak.core.Im
import org.apache.jackrabbit.oak.core.ImmutableTree;
import org.apache.jackrabbit.oak.namepath.NamePathMapper;
import org.apache.jackrabbit.oak.plugins.observation.filter.EventIterator;
+import org.apache.jackrabbit.oak.plugins.observation.filter.FilterProvider;
import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
import org.apache.jackrabbit.oak.spi.commit.Observable;
import org.apache.jackrabbit.oak.spi.commit.Observer;
@@ -53,7 +54,7 @@ import org.slf4j.LoggerFactory;
/**
* A {@code ChangeProcessor} generates observation {@link
javax.jcr.observation.Event}s
- * based on a {@link JcrFilterProvider filter} and delivers them to an {@link
EventListener}.
+ * based on a {@link FilterProvider filter} and delivers them to an {@link
EventListener}.
* <p>
* After instantiation a {@code ChangeProcessor} must be started in order to
start
* delivering observation events and stopped to stop doing so.
@@ -66,7 +67,7 @@ public class ChangeProcessor implements
private final NamePathMapper namePathMapper;
private final ListenerTracker tracker;
private final EventListener eventListener;
- private final AtomicReference<JcrFilterProvider> filterProvider;
+ private final AtomicReference<FilterProvider> filterProvider;
private Closeable observer;
private Registration mbean;
@@ -76,21 +77,21 @@ public class ChangeProcessor implements
ContentSession contentSession,
PermissionProvider permissionProvider,
NamePathMapper namePathMapper,
- ListenerTracker tracker, JcrFilterProvider filter) {
+ ListenerTracker tracker, FilterProvider filter) {
checkArgument(contentSession instanceof Observable);
this.contentSession = contentSession;
this.permissionProvider = permissionProvider;
this.namePathMapper = namePathMapper;
this.tracker = tracker;
eventListener = tracker.getTrackedListener();
- filterProvider = new AtomicReference<JcrFilterProvider>(filter);
+ filterProvider = new AtomicReference<FilterProvider>(filter);
}
/**
* Set the filter for the events this change processor will generate.
* @param filter
*/
- public void setFilterProvider(JcrFilterProvider filter) {
+ public void setFilterProvider(FilterProvider filter) {
filterProvider.set(filter);
}
@@ -127,7 +128,7 @@ public class ChangeProcessor implements
public void contentChanged(@Nonnull NodeState root, @Nullable CommitInfo
info) {
if (previousRoot != null) {
try {
- JcrFilterProvider provider = filterProvider.get();
+ FilterProvider provider = filterProvider.get();
// FIXME don't rely on toString for session id
if (provider.includeCommit(contentSession.toString(), info)) {
String path =
namePathMapper.getOakPath(provider.getPath());
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/JcrFilterProvider.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/JcrFilterProvider.java?rev=1545603&r1=1545602&r2=1545603&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/JcrFilterProvider.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/JcrFilterProvider.java
Tue Nov 26 10:41:05 2013
@@ -36,6 +36,7 @@ import org.apache.jackrabbit.oak.plugins
import org.apache.jackrabbit.oak.plugins.observation.filter.ACFilter;
import
org.apache.jackrabbit.oak.plugins.observation.filter.EventGenerator.Filter;
import org.apache.jackrabbit.oak.plugins.observation.filter.EventTypeFilter;
+import org.apache.jackrabbit.oak.plugins.observation.filter.FilterProvider;
import org.apache.jackrabbit.oak.plugins.observation.filter.Filters;
import org.apache.jackrabbit.oak.plugins.observation.filter.NodeTypeFilter;
import org.apache.jackrabbit.oak.plugins.observation.filter.PathFilter;
@@ -46,7 +47,7 @@ import org.apache.jackrabbit.oak.spi.sec
/**
* Provider for a filter filtering observation events according to a certain
criterion.
*/
-public class JcrFilterProvider {
+public class JcrFilterProvider implements FilterProvider {
private static final int ALL_EVENTS = NODE_ADDED | NODE_REMOVED |
NODE_MOVED | PROPERTY_ADDED |
PROPERTY_REMOVED | PROPERTY_CHANGED | PERSIST;
@@ -89,11 +90,13 @@ public class JcrFilterProvider {
this.includeClusterExternal = includeClusterExternal;
}
+ @Override
public boolean includeCommit(String sessionId, CommitInfo info) {
return (includeSessionLocal || !isLocal(sessionId, info))
&& (includeClusterExternal || !isExternal(info));
}
+ @Override
public Filter getFilter(ImmutableTree beforeTree, ImmutableTree afterTree,
TreePermission treePermission) {
List<Filter> filters = Lists.<Filter>newArrayList(
@@ -126,6 +129,7 @@ public class JcrFilterProvider {
return Filters.all(filters.toArray(new Filter[filters.size()]));
}
+ @Override
public String getPath() {
return path;
}
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java?rev=1545603&view=auto
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
(added)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
Tue Nov 26 10:41:05 2013
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.jackrabbit.oak.plugins.observation.filter;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
+
+import org.apache.jackrabbit.oak.core.ImmutableTree;
+import
org.apache.jackrabbit.oak.plugins.observation.filter.EventGenerator.Filter;
+import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
+import
org.apache.jackrabbit.oak.spi.security.authorization.permission.TreePermission;
+
+/**
+ * Instance of this class provide a {@link Filter} for observation
+ * events and a filter for commits.
+ */
+public interface FilterProvider {
+
+ /**
+ * Filter whole commits. Only commits for which this method returns
+ * {@code true} will be further processed to create individual events.
+ *
+ * @param sessionId id of the filtering (this) session
+ * @param info commit info of the commit or {@code null} if not
available
+ * @return {@code true} if observation events should be created
from this
+ * commit, {@code false} otherwise.
+ *
+ * @see org.apache.jackrabbit.oak.spi.commit.Observer
+ */
+ boolean includeCommit(@Nonnull String sessionId, @CheckForNull CommitInfo
info);
+
+ /**
+ * TODO document
+ * @param beforeTree
+ * @param afterTree
+ * @param treePermission
+ * @return
+ */
+ @Nonnull
+ Filter getFilter(@Nonnull ImmutableTree beforeTree, @Nonnull ImmutableTree
afterTree,
+ @Nonnull TreePermission treePermission);
+
+ /**
+ * TODO document
+ * @return
+ */
+ @Nonnull
+ String getPath();
+}
Modified:
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/observation/ObservationManagerImpl.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/observation/ObservationManagerImpl.java?rev=1545603&r1=1545602&r2=1545603&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/observation/ObservationManagerImpl.java
(original)
+++
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/observation/ObservationManagerImpl.java
Tue Nov 26 10:41:05 2013
@@ -43,6 +43,7 @@ import org.apache.jackrabbit.oak.plugins
import org.apache.jackrabbit.oak.plugins.observation.ChangeProcessor;
import org.apache.jackrabbit.oak.plugins.observation.ExcludeExternal;
import org.apache.jackrabbit.oak.plugins.observation.JcrFilterProvider;
+import org.apache.jackrabbit.oak.plugins.observation.filter.FilterProvider;
import org.apache.jackrabbit.oak.spi.commit.Observable;
import
org.apache.jackrabbit.oak.spi.security.authorization.permission.PermissionProvider;
import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
@@ -110,7 +111,7 @@ public class ObservationManagerImpl impl
public synchronized void addEventListener(EventListener listener, int
eventTypes, String absPath,
boolean isDeep, String[] uuid, String[] nodeTypeName, boolean
noLocal) throws RepositoryException {
boolean includeExternal = !(listener instanceof ExcludeExternal);
- JcrFilterProvider filterProvider = new JcrFilterProvider(ntMgr,
eventTypes, oakPath(absPath), isDeep,
+ FilterProvider filterProvider = new JcrFilterProvider(ntMgr,
eventTypes, oakPath(absPath), isDeep,
uuid, validateNodeTypeNames(nodeTypeName), !noLocal,
includeExternal);
ChangeProcessor processor = processors.get(listener);
if (processor == null) {
