org.apache.jackrabbit.api.observation.JackrabbitObservationManager Maven / Gradle / Ivy
/*
* 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.api.observation;
import javax.jcr.RepositoryException;
import javax.jcr.observation.EventListener;
import javax.jcr.observation.ObservationManager;
/**
* Jackrabbit specific extensions to {@link javax.jcr.observation.ObservationManager}.
*/
public interface JackrabbitObservationManager extends ObservationManager {
/**
* Adds an event listener that listens for the events specified
* by the passed {@link JackrabbitEventFilter}.
*
* In addition to the EventFilter, the set of events reported
* will be further filtered by the access rights of the
* current Session.
*
* See {@link JackrabbitEventFilter} for a description of the filtering parameters available.
*
* The filter of an already-registered EventListener can be
* changed at runtime by re-registering the same EventListener
* object (i.e. the same actual Java object) with a new filter.
* The implementation must ensure that no events are lost during the changeover.
*
* In addition to the filters placed on a listener above, the scope of
* observation support, in terms of which parts of a workspace are observable, may also
* be subject to implementation-specific restrictions. For example, in some
* repositories observation of changes in the jcr:system
* subgraph may not be supported.
*
* @param listener an {@link EventListener} object.
* @param filter an {@link JackrabbitEventFilter} object.
* @throws RepositoryException If an error occurs.
*/
void addEventListener(EventListener listener, JackrabbitEventFilter filter)
throws RepositoryException;
}