org.apache.cayenne.lifecycle.audit.AuditableProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cayenne-lifecycle Show documentation

There is a newer version: 5.0-M1

/*****************************************************************
 *   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.cayenne.lifecycle.audit;

/**
 * A superclass of application specific handlers of the {@link Auditable} annotation, that
 * provides basic needed callbacks.
 * 
 * @since 3.1
 */
public interface AuditableProcessor {

    /**
     * A method called by {@link AuditableFilter} that should audit records as appropriate
     * in a given application. Implementors may insert audit records in DB, log a message,
     * etc.
     * 
     * @param object the root auditable object. This is an object that is either annotated
     *            with {@link Auditable} or pointed to by another object annotated with
     *            {@link AuditableChild}.
     * @param operation a type of object change.
     */
    void audit(Object object, AuditableOperation operation);
}