org.apache.jackrabbit.spi.Event 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.spi;

import javax.jcr.RepositoryException;
import java.util.Map;

/**
 * Event is similar to the regular JCR Event and adds additional
 * information about the affected item.
 */
public interface Event {

    /**
     * An event of this type is generated when a node is added.
     */
    public static final int NODE_ADDED = javax.jcr.observation.Event.NODE_ADDED;

    /**
     * An event of this type is generated when a node is removed.
     */
    public static final int NODE_REMOVED = javax.jcr.observation.Event.NODE_REMOVED;

    /**
     * An event of this type is generated when a property is added.
     */
    public static final int PROPERTY_ADDED = javax.jcr.observation.Event.PROPERTY_ADDED;

    /**
     * An event of this type is generated when a property is removed.
     */
    public static final int PROPERTY_REMOVED = javax.jcr.observation.Event.PROPERTY_REMOVED;

    /**
     * An event of this type is generated when a property is changed.
     */
    public static final int PROPERTY_CHANGED = javax.jcr.observation.Event.PROPERTY_CHANGED;


    /**
     * An event of this type is generated when a node is moved.
     *
     * @since JCR 2.0
     */
    public static final int NODE_MOVED = javax.jcr.observation.Event.NODE_MOVED;

    /**
     * If event bundling is supported, this event is used to indicate a
     * bundle boundary within the event journal.
     *
     * @since JCR 2.0
     */
    public static final int PERSIST = javax.jcr.observation.Event.PERSIST;
    
    /**
     * Constant for observation listener interested in all types of events.
     */
    public static final int ALL_TYPES = Event.NODE_ADDED | Event.NODE_REMOVED |
            Event.PROPERTY_ADDED | Event.PROPERTY_CHANGED | Event.PROPERTY_REMOVED |
            Event.NODE_MOVED | Event.PERSIST;

    /**
     * Returns the type of this event: a constant defined by this interface.
     * One of:
     * 
     * {@link #NODE_ADDED}
     * {@link #NODE_REMOVED}
     * {@link #PROPERTY_ADDED}
     * {@link #PROPERTY_REMOVED}
     * {@link #PROPERTY_CHANGED}
     * {@link #NODE_MOVED}
     * {@link #PERSIST}
     * 
     *
     * @return the type of this event.
     */
    public int getType();

    /**
     * @return the path of the affected item. E.g. the added/removed node or the
     *         property that was added/removed/changed.
     */
    public Path getPath();

    /**
     * @return the id of the affected item.
     */
    public ItemId getItemId();

    /**
     * @return the id of the parent node of the affected item.
     */
    public NodeId getParentId();

    /**
     * @return the name of the primary node type of the 'associated' node of
     *         this event.
     * @see javax.jcr.observation.ObservationManager#addEventListener
     */
    public Name getPrimaryNodeTypeName();

    /**
     * @return the names of the mixin types of the 'associated' node of this
     *         event.
     * @see javax.jcr.observation.ObservationManager#addEventListener
     */
    public Name[] getMixinTypeNames();

    /**
     * Returns the user ID connected with this event. This is the string
     * returned by getUserID of the session that caused the event.
     *
     * @return a String.
     */
    public String getUserID();

    /**
     * Returns the information map associated with this event.
     *
     * @return A Map containing parameter information.
     * @throws RepositoryException if an error occurs.
     * @see javax.jcr.observation.Event#getInfo()
     * @since JCR 2.0
     */
    public Map getInfo() throws RepositoryException;

    /**
     * Returns the user data.
     *
     * @return the user data
     * @see javax.jcr.observation.Event#getUserData()
     * @since JCR 2.0
     */
    public String getUserData();

    /**
     * Returns the date when the change was persisted that caused this event.
     *
     * @return the date when the change was persisted that caused this event.
     * @throws javax.jcr.RepositoryException if an error occurs.
     * @see javax.jcr.observation.Event#getDate()
     * @since JCR 2.0
     */
    public long getDate() throws RepositoryException;
}