org.xwiki.observation.event.ActionExecutionEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-observation-api Show documentation

XWiki Commons - Observation - API

There is a newer version: 16.10.0-rc-1

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.observation.event;

import java.io.Serializable;

/**
 * An event triggered whenever a client request (action) is processed, like {@code /upload/} or {@code /view/}.
 * A specific event corresponds to only one {@link #actionName action type}.
 *
 * @version $Id: 12463848c7aaba3496243e13c5a5d003b83dc5b5 $
 * @deprecated since 3.2M3, use the {@code org.xwiki.bridge.event.ActionExecutedEvent} class from XWiki Platform instead
 */
// TODO: use the enumerated Action class when it's implemented...
@Deprecated
public class ActionExecutionEvent implements Event, Serializable
{
    /**
     * The version identifier for this Serializable class. Increment only if the serialized form of the class
     * changes.
     */
    private static final long serialVersionUID = 1L;

    /** The name of the executed action. */
    private String actionName;

    /**
     * Constructor initializing the action name of the event.
     *
     * @param actionName the name of the executed action
     */
    public ActionExecutionEvent(String actionName)
    {
        this.actionName = actionName;
    }

    /**
     * Gets the name of the action causing this event.
     *
     * @return the action causing this event, like upload or login
     */
    public String getActionName()
    {
        return this.actionName;
    }

    @Override
    public int hashCode()
    {
        return getActionName().hashCode();
    }

    @Override
    public boolean equals(Object object)
    {
        if (object instanceof ActionExecutionEvent) {
            return getActionName().equals(((ActionExecutionEvent) object).getActionName());
        }
        return getActionName().equals(object);
    }

    @Override
    public boolean matches(Object otherEvent)
    {
        boolean isMatching = false;
        if (this.getClass().isAssignableFrom(otherEvent.getClass())) {
            ActionExecutionEvent actionEvent = (ActionExecutionEvent) otherEvent;
            isMatching = getActionName().equals(actionEvent.getActionName());
        }
        return isMatching;
    }
}