org.modeshape.jcr.JcrObservationManager Maven / Gradle / Ivy
package org.modeshape.jcr;
import static org.modeshape.jcr.api.observation.Event.Sequencing.NODE_SEQUENCED;
import static org.modeshape.jcr.api.observation.Event.Sequencing.NODE_SEQUENCING_FAILURE;
import static org.modeshape.jcr.api.observation.Event.Sequencing.OUTPUT_PATH;
import static org.modeshape.jcr.api.observation.Event.Sequencing.SELECTED_PATH;
import static org.modeshape.jcr.api.observation.Event.Sequencing.SEQUENCED_NODE_ID;
import static org.modeshape.jcr.api.observation.Event.Sequencing.SEQUENCED_NODE_PATH;
import static org.modeshape.jcr.api.observation.Event.Sequencing.SEQUENCER_NAME;
import static org.modeshape.jcr.api.observation.Event.Sequencing.SEQUENCING_FAILURE_CAUSE;
import static org.modeshape.jcr.api.observation.Event.Sequencing.USER_ID;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.jcr.AccessDeniedException;
import javax.jcr.RangeIterator;
import javax.jcr.RepositoryException;
import javax.jcr.observation.Event;
import javax.jcr.observation.EventIterator;
import javax.jcr.observation.EventJournal;
import javax.jcr.observation.EventListener;
import javax.jcr.observation.EventListenerIterator;
import javax.jcr.observation.ObservationManager;
import org.modeshape.common.annotation.Immutable;
import org.modeshape.common.annotation.NotThreadSafe;
import org.modeshape.common.annotation.ThreadSafe;
import org.modeshape.common.logging.Logger;
import org.modeshape.common.util.CheckArg;
import org.modeshape.common.util.StringUtil;
import org.modeshape.jcr.api.monitor.ValueMetric;
import org.modeshape.jcr.api.observation.PropertyEvent;
import org.modeshape.jcr.api.value.DateTime;
import org.modeshape.jcr.cache.NodeKey;
import org.modeshape.jcr.cache.change.AbstractNodeChange;
import org.modeshape.jcr.cache.change.AbstractSequencingChange;
import org.modeshape.jcr.cache.change.Change;
import org.modeshape.jcr.cache.change.ChangeSet;
import org.modeshape.jcr.cache.change.ChangeSetListener;
import org.modeshape.jcr.cache.change.NodeAdded;
import org.modeshape.jcr.cache.change.NodeMoved;
import org.modeshape.jcr.cache.change.NodeRemoved;
import org.modeshape.jcr.cache.change.NodeRenamed;
import org.modeshape.jcr.cache.change.NodeReordered;
import org.modeshape.jcr.cache.change.NodeSequenced;
import org.modeshape.jcr.cache.change.NodeSequencingFailure;
import org.modeshape.jcr.cache.change.Observable;
import org.modeshape.jcr.cache.change.PropertyAdded;
import org.modeshape.jcr.cache.change.PropertyChanged;
import org.modeshape.jcr.cache.change.PropertyRemoved;
import org.modeshape.jcr.value.Name;
import org.modeshape.jcr.value.Path;
import org.modeshape.jcr.value.PathFactory;
/**
* The implementation of JCR {@link ObservationManager}.
*
* @author Horia Chiorean
*/
@ThreadSafe
class JcrObservationManager implements ObservationManager, ChangeSetListener {
/**
* The key for storing the {@link JcrObservationManager#setUserData(String) observation user data} in the
* {@link ExecutionContext}'s {@link ExecutionContext#getData() data}.
*/
static final String OBSERVATION_USER_DATA_KEY = "org.modeshape.jcr.observation.userdata";
/**
* The keys which provide extra information in case of a move
*/
static final String MOVE_FROM_KEY = "srcAbsPath";
static final String MOVE_TO_KEY = "destAbsPath";
/**
* The keys which provide extra information in case of a reorder
*/
static final String ORDER_DEST_KEY = "destChildRelPath";
static final String ORDER_SRC_KEY = "srcChildRelPath";
/**
* The repository observable the JCR listeners will be registered with.
*/
private final Observable repositoryObservable;
/**
* The map of the JCR repository listeners and their associated wrapped class.
*/
private final Map listeners;
/**
* The associated session.
*/
private final JcrSession session;
/**
* The name of the session's workspace; cached for performance reasons.
*/
private final String workspaceName;
private final String systemWorkspaceName;
/**
* An object recording various metrics
*/
private final RepositoryStatistics repositoryStatistics;
/**
* A map of [changeSetHashCode, integer] which keep track of the events which have been received by the observation manager
* and dispatched to the individual listeners. This is used for statistic purposes only.
*/
private final Map changesReceivedAndDispatched;
/**
* A lock which guards the JcrObservationManager#changesReceivedAndDispatched map
*/
private final Lock changesLock;
/**
* A lock used to provide thread-safe guarantees when working it the repository observable
*/
private final ReadWriteLock listenersLock;
/**
* @param session the owning session (never null
)
* @param repositoryObservable the repository observable used to register JCR listeners (never null
)
* @param statistics a {@link RepositoryStatistics} instance with which the {@link ValueMetric#EVENT_QUEUE_SIZE} metric is
* updated
* @throws IllegalArgumentException if either parameter is null
*/
JcrObservationManager( JcrSession session,
Observable repositoryObservable,
RepositoryStatistics statistics ) {
CheckArg.isNotNull(session, "session");
CheckArg.isNotNull(repositoryObservable, "repositoryObservable");
CheckArg.isNotNull(statistics, "statistics");
this.session = session;
this.workspaceName = this.session.getWorkspace().getName();
this.systemWorkspaceName = this.session.repository().systemWorkspaceName();
this.repositoryObservable = repositoryObservable;
// this is registered as an observer just so it can count the number of events dispatched
this.repositoryObservable.register(this);
this.listenersLock = new ReentrantReadWriteLock(true);
this.listeners = new HashMap();
this.repositoryStatistics = statistics;
this.changesLock = new ReentrantLock();
this.changesReceivedAndDispatched = new HashMap();
}
@Override
public void addEventListener( EventListener listener,
int eventTypes,
String absPath,
boolean isDeep,
String[] uuid,
String[] nodeTypeName,
boolean noLocal ) throws RepositoryException {
CheckArg.isNotNull(listener, "listener");
checkSession(); // make sure session is still active
// create wrapper and register
JcrListenerAdapter adapter = new JcrListenerAdapter(listener, eventTypes, absPath, isDeep, uuid, nodeTypeName, noLocal);
// unregister if already registered
try {
listenersLock.writeLock().lock();
this.repositoryObservable.unregister(adapter);
this.repositoryObservable.register(adapter);
this.listeners.put(listener, adapter);
} finally {
listenersLock.writeLock().unlock();
}
}
/**
* @throws RepositoryException if session is not active
*/
void checkSession() throws RepositoryException {
session.checkLive();
}
/**
* @return the node type manager
* @throws RepositoryException if there is a problem
*/
JcrNodeTypeManager getNodeTypeManager() throws RepositoryException {
return this.session.getWorkspace().getNodeTypeManager();
}
@Override
public void notify( ChangeSet changeSet ) {
incrementEventQueueStatistic(changeSet);
}
private void incrementEventQueueStatistic( ChangeSet changeSet ) {
// whenever a change set is received from the bus, increment the que size
repositoryStatistics.increment(ValueMetric.EVENT_QUEUE_SIZE);
try {
changesLock.lock();
if (!this.changesReceivedAndDispatched.containsKey(changeSet.hashCode())) {
// none of the adapters have processed this change set yet, register it
changesReceivedAndDispatched.put(changeSet.hashCode(), new AtomicInteger(listeners.size()));
}
} finally {
changesLock.unlock();
}
}
private void decrementEventQueueStatistic( ChangeSet changeSet ) {
try {
changesLock.lock();
if (changesReceivedAndDispatched.containsKey(changeSet.hashCode())) {
// the change set has already been registered (and the que size incremented)
int timesProcessed = changesReceivedAndDispatched.get(changeSet.hashCode()).decrementAndGet();
if (timesProcessed == 0) {
repositoryStatistics.decrement(ValueMetric.EVENT_QUEUE_SIZE);
changesReceivedAndDispatched.remove(changeSet.hashCode());
}
} else {
// the change got to this adapter (from the bus) before it got to the observation manager, so it'll be registered
// this listener already received the event, so total count of expected listeners is decremented by 1
changesReceivedAndDispatched.put(changeSet.hashCode(), new AtomicInteger(listeners.size() - 1));
}
} finally {
changesLock.unlock();
}
}
@Override
public EventListenerIterator getRegisteredEventListeners() throws RepositoryException {
checkSession(); // make sure session is still active
try {
listenersLock.readLock().lock();
return new JcrEventListenerIterator(Collections.unmodifiableSet(this.listeners.keySet()));
} finally {
listenersLock.readLock().unlock();
}
}
final String stringFor( Path path ) {
return session.stringFactory().create(path);
}
final String stringFor( Path.Segment segment ) {
return this.session.stringFactory().create(segment);
}
final String stringFor( Name name ) {
return this.session.stringFactory().create(name);
}
final PathFactory pathFactory() {
return this.session.pathFactory();
}
String getSessionId() {
return this.session.context().getProcessId();
}
final String getWorkspaceName() {
return workspaceName;
}
final String getSystemWorkspaceName() {
return systemWorkspaceName;
}
final String nodeIdentifier( NodeKey key ) {
return session.nodeIdentifier(key);
}
/**
* Remove all of the listeners. This is typically called when the {@link JcrSession#logout() session logs out}.
*/
void removeAllEventListeners() {
try {
listenersLock.writeLock().lock();
for (JcrListenerAdapter listener : this.listeners.values()) {
assert (listener != null);
this.repositoryObservable.unregister(listener);
}
this.listeners.clear();
} finally {
listenersLock.writeLock().unlock();
}
}
@Override
public void removeEventListener( EventListener listener ) throws RepositoryException {
checkSession(); // make sure session is still active
CheckArg.isNotNull(listener, "listener");
try {
listenersLock.writeLock().lock();
JcrListenerAdapter jcrListener = this.listeners.remove(listener);
if (jcrListener != null) {
this.repositoryObservable.unregister(jcrListener);
}
} finally {
listenersLock.writeLock().unlock();
}
}
@Override
public void setUserData( String userData ) {
// User data value may be null
this.session.addContextData(OBSERVATION_USER_DATA_KEY, userData);
}
/**
* {@inheritDoc}
*
* Since ModeShape does not support journaled observation, this method returns null.
*
*
* @see javax.jcr.observation.ObservationManager#getEventJournal()
*/
@Override
public EventJournal getEventJournal() {
return null;
}
/**
* {@inheritDoc}
*
* Since ModeShape does not support journaled observation, this method returns null.
*
*
* @see javax.jcr.observation.ObservationManager#getEventJournal(int, java.lang.String, boolean, java.lang.String[],
* java.lang.String[])
*/
@Override
public EventJournal getEventJournal( int eventTypes,
String absPath,
boolean isDeep,
String[] uuid,
String[] nodeTypeName ) {
return null;
}
/**
* An implementation of JCR {@link javax.jcr.RangeIterator} extended by the event and event listener iterators.
*
* @param the type being iterated over
*/
class JcrRangeIterator implements RangeIterator {
/**
* The elements being iterated over.
*/
private final List extends E> elements;
/**
* The current position in the iterator.
*/
private int position = 0;
/**
* @param elements the elements to iterator over
* @throws IllegalArgumentException if elements
is null
*/
public JcrRangeIterator( Collection extends E> elements ) {
CheckArg.isNotNull(elements, "elements");
this.elements = new ArrayList(elements);
}
@Override
public long getPosition() {
return this.position;
}
@Override
public long getSize() {
return this.elements.size();
}
@Override
public boolean hasNext() {
return (getPosition() < getSize());
}
@Override
public Object next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
Object element = this.elements.get(this.position);
++this.position;
return element;
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
@Override
public void skip( long skipNum ) {
this.position += skipNum;
if (!hasNext()) {
throw new NoSuchElementException();
}
}
}
/**
* An implementation of the JCR {@link EventListenerIterator}.
*/
class JcrEventListenerIterator extends JcrRangeIterator implements EventListenerIterator {
/**
* @param listeners the listeners being iterated over
* @throws IllegalArgumentException if listeners
is null
*/
public JcrEventListenerIterator( Collection listeners ) {
super(listeners);
}
@Override
public EventListener nextEventListener() {
return (EventListener)next();
}
}
/**
* An implementation of JCR {@link javax.jcr.observation.EventIterator}.
*/
class JcrEventIterator extends JcrRangeIterator implements EventIterator {
/**
* @param events the events being iterated over
* @throws IllegalArgumentException if events
is null
*/
public JcrEventIterator( Collection events ) {
super(events);
}
@Override
public Event nextEvent() {
return (Event)next();
}
}
/**
* The information related to and shared by a set of events that represent a single logical operation.
*/
@Immutable
class JcrEventBundle {
/**
* The date and time of the event bundle.
*/
private final DateTime date;
/**
* The user ID.
*/
private final String userId;
/**
* The optional user data string (may be null)
*/
private final String userData;
public JcrEventBundle( DateTime dateTime,
String userId,
String userData ) {
this.userId = userId;
this.userData = userData;
this.date = dateTime;
}
public String getUserID() {
return this.userId;
}
/**
* @return date
*/
public DateTime getDate() {
return date;
}
/**
* @return userData
*/
public String getUserData() {
return userData;
}
}
/**
* An implementation of JCR {@link org.modeshape.jcr.api.observation.Event}.
*/
@Immutable
class JcrEvent implements org.modeshape.jcr.api.observation.Event {
private final String id;
/**
* The node path.
*/
private final String path;
/**
* The event type.
*/
private final int type;
/**
* The immutable bundle information, which may be shared amongst multiple events.
*/
private final JcrEventBundle bundle;
/**
* A map of extra information for regarding the event
*/
private Map info;
/**
* @param bundle the event bundle information
* @param type the event type
* @param path the node path
* @param id the node identifier
*/
JcrEvent( JcrEventBundle bundle,
int type,
String path,
String id ) {
this.type = type;
this.path = path;
this.bundle = bundle;
this.id = id;
}
JcrEvent( JcrEventBundle bundle,
int type,
String path,
String id,
Map info ) {
this(bundle, type, path, id);
this.info = info;
}
@Override
public String getPath() {
return this.path;
}
@Override
public int getType() {
return this.type;
}
@Override
public String getUserID() {
return bundle.getUserID();
}
@Override
public long getDate() {
return bundle.getDate().getMilliseconds();
}
@Override
public String getIdentifier() {
return id;
}
@Override
public String getUserData() {
return bundle.getUserData();
}
@Override
public Map getInfo() {
return info != null ? Collections.unmodifiableMap(info) : Collections.emptyMap();
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
switch (this.type) {
case Event.NODE_ADDED:
sb.append("Node added");
break;
case Event.NODE_REMOVED:
sb.append("Node removed");
break;
case Event.PROPERTY_ADDED:
sb.append("Property added");
break;
case Event.PROPERTY_CHANGED:
sb.append("Property changed");
break;
case Event.PROPERTY_REMOVED:
sb.append("Property removed");
break;
case Event.NODE_MOVED:
if (info.containsKey(MOVE_FROM_KEY) || info.containsKey(MOVE_TO_KEY)) {
sb.append("Node moved");
sb.append(" from ").append(info.get(MOVE_FROM_KEY)).append(" to ").append(info.get(MOVE_TO_KEY));
} else {
sb.append("Node reordered");
String destination = info.get(ORDER_DEST_KEY).toString();
if (destination == null) {
destination = " at the end of the children list";
}
sb.append(" from ").append(info.get(ORDER_SRC_KEY)).append(" to ").append(destination);
}
sb.append(" by ").append(getUserID());
return sb.toString();
case NODE_SEQUENCED:
sb.append("Node sequenced");
sb.append(" sequenced node:")
.append(info.get(SEQUENCED_NODE_ID))
.append(" at path:")
.append(info.get(SEQUENCED_NODE_PATH));
sb.append(" ,output node:").append(getIdentifier()).append(" at path:").append(getPath());
return sb.toString();
case NODE_SEQUENCING_FAILURE: {
sb.append("Node sequencing failure");
sb.append(" sequenced node:")
.append(info.get(SEQUENCED_NODE_ID))
.append(" at path:")
.append(info.get(SEQUENCED_NODE_PATH));
sb.append(" ,cause: ").append(getInfo().get(SEQUENCING_FAILURE_CAUSE));
return sb.toString();
}
}
sb.append(" at ").append(path).append(" by ").append(getUserID());
return sb.toString();
}
}
class JcrPropertyEvent extends JcrEvent implements PropertyEvent {
private final Object currentValue;
private final Object oldValue;
JcrPropertyEvent( JcrEventBundle bundle,
int type,
String path,
String id,
Object currentValue,
Object oldValue ) {
super(bundle, type, path, id);
this.currentValue = currentValue;
this.oldValue = oldValue;
}
JcrPropertyEvent( JcrEventBundle bundle,
int type,
String path,
String id,
Object currentValue ) {
this(bundle, type, path, id, currentValue, null);
}
@Override
public Object getCurrentValue() {
return firstValueFrom(currentValue);
}
@Override
public boolean isMultiValue() {
return currentValue instanceof Object[];
}
@Override
public List> getCurrentValues() {
return listValueFrom(currentValue);
}
@Override
public boolean wasMultiValue() {
return oldValue instanceof Object[];
}
@Override
public Object getPreviousValue() {
return firstValueFrom(oldValue);
}
@Override
public List> getPreviousValues() {
return listValueFrom(oldValue);
}
private List> listValueFrom( Object value ) {
if (value == null) {
return null;
}
if (value instanceof Object[]) {
return ((Object[])value).length > 0 ? Arrays.asList((Object[])value) : Collections.emptyList();
}
return Arrays.asList(value);
}
private Object firstValueFrom( Object value ) {
if (value == null) {
return null;
}
if (value instanceof Object[]) {
return ((Object[])value).length > 0 ? ((Object[])value)[0] : null;
}
return value;
}
}
/**
* The JcrListener
class wraps JCR {@link EventListener} and is responsible for converting
* {@link org.modeshape.jcr.cache.change.Change events} into JCR {@link Event events}.
*/
@NotThreadSafe
class JcrListenerAdapter implements ChangeSetListener {
private final Logger logger = Logger.getLogger(getClass());
/**
* The node path whose events should be handled (or null
) if all node paths should be handled.
*/
private final String absPath;
/**
* The JCR event listener.
*/
private final EventListener delegate;
/**
* The event types this listener is interested in handling.
*/
private final int eventTypes;
/**
* A flag indicating if events of child nodes of the absPath
should be processed.
*/
private final boolean isDeep;
/**
* The node type names or null
. If a node with one of these types is the source node of an event than this
* listener wants to process that event. If null
or empty than this listener wants to handle nodes of any
* type.
*/
private final String[] nodeTypeNames;
/**
* A flag indicating if events generated by the session that registered this listener should be ignored.
*/
private final boolean noLocal;
/**
* The node UUIDs or null
. If a node with one of these UUIDs is the source node of an event than this
* listener wants to handle this event. If null
or empty than this listener wants to handle nodes with any
* UUID.
*/
private final String[] uuids;
/**
* @param delegate the JCR listener
* @param eventTypes a combination of one or more JCR event types
* @param absPath the absolute path of a node or null
if all node paths
* @param isDeep indicates if paths below absPath
should be considered
* @param uuids UUIDs or null
* @param nodeTypeNames node type names or null
* @param noLocal indicates if events from this listener's session should be ignored
*/
JcrListenerAdapter( EventListener delegate,
int eventTypes,
String absPath,
boolean isDeep,
String[] uuids,
String[] nodeTypeNames,
boolean noLocal ) {
assert (delegate != null);
this.delegate = delegate;
this.eventTypes = eventTypes;
this.absPath = absPath;
this.isDeep = isDeep;
this.uuids = uuids;
if (this.uuids != null) {
Arrays.sort(this.uuids);
}
this.nodeTypeNames = nodeTypeNames;
this.noLocal = noLocal;
}
@SuppressWarnings( "synthetic-access" )
@Override
public void notify( ChangeSet changeSet ) {
decrementEventQueueStatistic(changeSet);
if (shouldReject(changeSet)) {
return;
}
Collection events = new ArrayList();
String userData = changeSet.getUserData().get(OBSERVATION_USER_DATA_KEY);
JcrEventBundle bundle = new JcrEventBundle(changeSet.getTimestamp(), changeSet.getUserId(), userData);
for (Change change : changeSet) {
processChange(events, bundle, change);
}
// notify delegate
if (!events.isEmpty()) {
this.delegate.onEvent(new JcrEventIterator(events));
}
}
private boolean shouldReject( ChangeSet changeSet ) {
return !acceptBasedOnOriginatingSession(changeSet) || !acceptBasedOnOriginatingWorkspace(changeSet);
}
private void processChange( Collection events,
JcrEventBundle bundle,
Change change ) {
if (!(change instanceof AbstractNodeChange)) {
return;
}
AbstractNodeChange nodeChange = (AbstractNodeChange)change;
if (logger.isDebugEnabled()) {
logger.debug("Received change: " + nodeChange);
}
if (shouldReject(nodeChange)) {
return;
}
// process event making sure we have the right event type
Path newPath = nodeChange.getPath();
String nodeId = nodeIdentifier(nodeChange.getKey());
// node moved
if (nodeChange instanceof NodeMoved) {
NodeMoved nodeMovedChange = (NodeMoved)nodeChange;
Path oldPath = nodeMovedChange.getOldPath();
fireNodeMoved(events, bundle, newPath, nodeId, oldPath);
} else if (nodeChange instanceof NodeRenamed) {
NodeRenamed nodeRenamedChange = (NodeRenamed)nodeChange;
Path oldPath = pathFactory().create(newPath.subpath(0, newPath.size() - 1), nodeRenamedChange.getOldSegment());
fireNodeMoved(events, bundle, newPath, nodeId, oldPath);
} else if (nodeChange instanceof NodeReordered) {
NodeReordered nodeReordered = (NodeReordered)nodeChange;
Path oldPath = nodeReordered.getOldPath();
if (eventListenedFor(Event.NODE_MOVED)) {
Map info = new HashMap();
// check if the reordering wasn't at the end by any chance
if (nodeReordered.getReorderedBeforePath() != null) {
info.put(ORDER_DEST_KEY, stringFor(nodeReordered.getReorderedBeforePath().getLastSegment()));
} else {
info.put(ORDER_DEST_KEY, null);
}
info.put(ORDER_SRC_KEY, stringFor(oldPath.getLastSegment()));
events.add(new JcrEvent(bundle, Event.NODE_MOVED, stringFor(newPath), nodeId,
Collections.unmodifiableMap(info)));
}
fireExtraEventsForMove(events, bundle, newPath, nodeId, oldPath);
} else if (nodeChange instanceof NodeAdded && eventListenedFor(Event.NODE_ADDED)) {
// create event for added node
events.add(new JcrEvent(bundle, Event.NODE_ADDED, stringFor(newPath), nodeId));
} else if (nodeChange instanceof NodeRemoved && eventListenedFor(Event.NODE_REMOVED)) {
// create event for removed node
events.add(new JcrEvent(bundle, Event.NODE_REMOVED, stringFor(newPath), nodeId));
} else if (nodeChange instanceof PropertyChanged && eventListenedFor(Event.PROPERTY_CHANGED)) {
// create event for changed property
PropertyChanged propertyChanged = (PropertyChanged)nodeChange;
Name propertyName = propertyChanged.getNewProperty().getName();
Path propertyPath = pathFactory().create(newPath, stringFor(propertyName));
boolean isMultiValue = propertyChanged.getNewProperty().isMultiple();
Object currentValue = isMultiValue ? propertyChanged.getNewProperty().getValuesAsArray() : propertyChanged.getNewProperty()
.getFirstValue();
boolean wasMultiValue = propertyChanged.getOldProperty().isMultiple();
Object oldValue = wasMultiValue ? propertyChanged.getOldProperty().getValuesAsArray() : propertyChanged.getOldProperty()
.getFirstValue();
events.add(new JcrPropertyEvent(bundle, Event.PROPERTY_CHANGED, stringFor(propertyPath), nodeId, currentValue,
oldValue));
} else if (nodeChange instanceof PropertyAdded && eventListenedFor(Event.PROPERTY_ADDED)) {
PropertyAdded propertyAdded = (PropertyAdded)nodeChange;
Name propertyName = propertyAdded.getProperty().getName();
Path propertyPath = pathFactory().create(newPath, stringFor(propertyName));
boolean isMultiValue = propertyAdded.getProperty().isMultiple();
Object currentValue = isMultiValue ? propertyAdded.getProperty().getValuesAsArray() : propertyAdded.getProperty()
.getFirstValue();
events.add(new JcrPropertyEvent(bundle, Event.PROPERTY_ADDED, stringFor(propertyPath), nodeId, currentValue));
} else if (nodeChange instanceof PropertyRemoved && eventListenedFor(Event.PROPERTY_REMOVED)) {
// create event for removed property
PropertyRemoved propertyRemoved = (PropertyRemoved)nodeChange;
Name propertyName = propertyRemoved.getProperty().getName();
Path propertyPath = pathFactory().create(newPath, propertyName);
boolean isMultiValue = propertyRemoved.getProperty().isMultiple();
Object currentValue = isMultiValue ? propertyRemoved.getProperty().getValuesAsArray() : propertyRemoved.getProperty()
.getFirstValue();
events.add(new JcrPropertyEvent(bundle, Event.PROPERTY_REMOVED, stringFor(propertyPath), nodeId, currentValue));
} else if (nodeChange instanceof NodeSequenced && eventListenedFor(NODE_SEQUENCED)) {
// create event for the sequenced node
NodeSequenced sequencedChange = (NodeSequenced)nodeChange;
Map infoMap = createEventInfoMapForSequencerChange(sequencedChange);
events.add(new JcrEvent(bundle, NODE_SEQUENCED, stringFor(sequencedChange.getOutputNodePath()),
nodeIdentifier(sequencedChange.getOutputNodeKey()), infoMap));
} else if (nodeChange instanceof NodeSequencingFailure && eventListenedFor(NODE_SEQUENCING_FAILURE)) {
// create event for the sequencing failure
NodeSequencingFailure sequencingFailure = (NodeSequencingFailure)nodeChange;
Map infoMap = createEventInfoMapForSequencerChange(sequencingFailure);
infoMap.put(SEQUENCING_FAILURE_CAUSE, sequencingFailure.getCause());
events.add(new JcrEvent(bundle, NODE_SEQUENCING_FAILURE, stringFor(sequencingFailure.getPath()), nodeId, infoMap));
}
}
private Map createEventInfoMapForSequencerChange( AbstractSequencingChange sequencingChange ) {
Map infoMap = new HashMap();
infoMap.put(SEQUENCED_NODE_PATH, stringFor(sequencingChange.getPath()));
infoMap.put(SEQUENCED_NODE_ID, nodeIdentifier(sequencingChange.getKey()));
infoMap.put(OUTPUT_PATH, sequencingChange.getOutputPath());
infoMap.put(SELECTED_PATH, sequencingChange.getSelectedPath());
infoMap.put(SEQUENCER_NAME, sequencingChange.getSequencerName());
infoMap.put(USER_ID, sequencingChange.getUserId());
return infoMap;
}
private void fireNodeMoved( Collection events,
JcrEventBundle bundle,
Path newPath,
String nodeId,
Path oldPath ) {
if (eventListenedFor(Event.NODE_MOVED)) {
Map info = new HashMap();
info.put(MOVE_FROM_KEY, stringFor(oldPath));
info.put(MOVE_TO_KEY, stringFor(newPath));
events.add(new JcrEvent(bundle, Event.NODE_MOVED, stringFor(newPath), nodeId, Collections.unmodifiableMap(info)));
}
fireExtraEventsForMove(events, bundle, newPath, nodeId, oldPath);
}
private void fireExtraEventsForMove( Collection events,
JcrEventBundle bundle,
Path newPath,
String nodeId,
Path oldPath ) {
// JCR 1.0 expects these methods in addition to the NODE_MOVED event
if (eventListenedFor(Event.NODE_ADDED)) {
events.add(new JcrEvent(bundle, Event.NODE_ADDED, stringFor(newPath), nodeId));
}
if (eventListenedFor(Event.NODE_REMOVED)) {
events.add(new JcrEvent(bundle, Event.NODE_REMOVED, stringFor(oldPath), nodeId));
}
}
private boolean shouldReject( AbstractNodeChange nodeChange ) {
return !acceptBasedOnNodeTypeName(nodeChange) || !acceptBasedOnPath(nodeChange) || !acceptBasedOnUuid(nodeChange)
|| !acceptBasedOnPermission(nodeChange) || !acceptIfLockChange(nodeChange);
}
/**
* In case of changes involving locks from the system workspace, the TCK expects that the only property changes be for
* lock owner and lock isDeep, which will be fired from the locked node. Therefore, we should exclude property
* notifications from the lock node from the system workspace.
*
* @param nodeChange the internal event
* @return true if the change should be accepted/propagated
*/
private boolean acceptIfLockChange( AbstractNodeChange nodeChange ) {
if (!(nodeChange instanceof PropertyAdded || nodeChange instanceof PropertyRemoved || nodeChange instanceof PropertyChanged)) {
return true;
}
Path path = nodeChange.getPath();
if (path.size() < 2) {
return true;
}
Name firstSegmentName = path.subpath(0, 1).getLastSegment().getName();
boolean isSystemLockChange = JcrLexicon.SYSTEM.equals(firstSegmentName)
&& ModeShapeLexicon.LOCKS.equals(path.getParent().getLastSegment().getName());
return !isSystemLockChange;
}
private boolean eventListenedFor( int eventType ) {
return (this.eventTypes & eventType) == eventType;
}
/**
* @param nodeChange the change being processed
* @return true
if the {@link JcrSession#checkPermission(String, String)} returns true for a
* {@link ModeShapePermissions#READ} permission on the node from the change
*/
@SuppressWarnings( "synthetic-access" )
private boolean acceptBasedOnPermission( AbstractNodeChange nodeChange ) {
try {
session.checkPermission(parentNodePathOfChange(nodeChange), ModeShapePermissions.READ);
return true;
} catch (AccessDeniedException e) {
return false;
}
}
private boolean acceptBasedOnOriginatingWorkspace( ChangeSet changeSet ) {
boolean sameWorkspace = getWorkspaceName().equalsIgnoreCase(changeSet.getWorkspaceName());
boolean isSystemWorkspace = getSystemWorkspaceName().equalsIgnoreCase(changeSet.getWorkspaceName());
return sameWorkspace || isSystemWorkspace;
}
/**
* @param changeSet the changes being processed
* @return true
if event occurred in a different session or if events from same session should be processed
*/
private boolean acceptBasedOnOriginatingSession( ChangeSet changeSet ) {
if (this.noLocal) {
return !getSessionId().equals(changeSet.getProcessKey());
}
return true;
}
/**
* @param change the change being processed
* @return true
if all node types should be processed or if changed node type name matches a specified type
*/
@SuppressWarnings( "synthetic-access" )
private boolean acceptBasedOnNodeTypeName( AbstractNodeChange change ) {
// JSR 283#12.5.3.4.3
if (nodeTypeNames != null && nodeTypeNames.length == 0) {
return false;
}
if (shouldCheckNodeType()) {
String primaryTypeName = null;
Set mixinTypeNames = null;
try {
Path parentPath = parentNodePathOfChange(change);
AbstractJcrNode parentNode = session.node(parentPath);
mixinTypeNames = new HashSet(parentNode.getMixinTypeNames().size());
for (Name mixinName : parentNode.getMixinTypeNames()) {
mixinTypeNames.add(stringFor(mixinName));
}
primaryTypeName = stringFor(parentNode.getPrimaryTypeName());
return getNodeTypeManager().isDerivedFrom(this.nodeTypeNames,
primaryTypeName,
mixinTypeNames.toArray(new String[mixinTypeNames.size()]));
} catch (RepositoryException e) {
logger.error(e, JcrI18n.cannotPerformNodeTypeCheck, primaryTypeName, mixinTypeNames, this.nodeTypeNames);
return false;
}
}
return true;
}
/**
* @param change the change being processed
* @return true
if there is no absolute path or if change path matches or optionally is a deep match
*/
@SuppressWarnings( "synthetic-access" )
private boolean acceptBasedOnPath( AbstractNodeChange change ) {
if (!StringUtil.isBlank(absPath)) {
Path matchPath = session.pathFactory().create(this.absPath);
Path parentPath = parentNodePathOfChange(change);
return this.isDeep ? matchPath.isAtOrAbove(parentPath) : matchPath.equals(parentPath);
}
return true;
}
/**
* @param change the change being processed
* @return true
if there are no UUIDs to match or change UUID matches
*/
private boolean acceptBasedOnUuid( AbstractNodeChange change ) {
// JSR_283#12.5.3.4.2
if (this.uuids != null && this.uuids.length == 0) {
return false;
}
if ((this.uuids != null) && (this.uuids.length > 0)) {
String matchUuidString = nodeIdentifier(change.getKey());
return Arrays.binarySearch(this.uuids, matchUuidString) >= 0;
}
return true;
}
private Path parentNodePathOfChange( AbstractNodeChange change ) {
Path changePath = change.getPath();
if (change instanceof PropertyAdded || change instanceof PropertyRemoved || change instanceof PropertyChanged) {
return changePath;
}
return changePath.isRoot() ? changePath : changePath.getParent();
}
@Override
public boolean equals( Object obj ) {
return (obj != null) && (obj instanceof JcrListenerAdapter) && (this.delegate == ((JcrListenerAdapter)obj).delegate);
}
@Override
public int hashCode() {
return this.delegate.hashCode();
}
/**
* @return true
if the node type of the event locations need to be checked
*/
private boolean shouldCheckNodeType() {
return ((this.nodeTypeNames != null) && (this.nodeTypeNames.length > 0));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy