com.avaje.ebean.event.BeanPersistController Maven / Gradle / Ivy
/**
* Copyright (C) 2006 Robin Bygrave
*
* This file is part of Ebean.
*
* Ebean 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.
*
* Ebean 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 Ebean; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.avaje.ebean.event;
import java.util.Set;
/**
* Used to enhance or override the default bean persistence mechanism.
*
* Note that if want to totally change the finding, you need to use a BeanFinder
* rather than using postLoad().
*
*
* Note that getTransaction() on the PersistRequest returns the transaction used
* for the insert, update, delete or fetch. To explicitly use this same
* transaction you should use this transaction via methods on EbeanServer.
*
*
*
*
* Object extaBeanToSave = ...;
* Transaction t = request.getTransaction();
* EbeanServer server = request.getEbeanServer();
* server.save(extraBeanToSave, t);
*
*
*
*
* It is worth noting that BeanPersistListener is different in three main ways
* from BeanPersistController postXXX methods.
*
* - BeanPersistListener only sees successfully committed events.
* BeanController pre and post methods occur before the commit or a rollback and
* will see events that are later rolled back
* - BeanPersistListener runs in a background thread and will not effect the
* response time of the actual persist where as BeanController code will
* - BeanPersistListener can be notified of events from other servers in a
* cluster.
*
*
*
* A BeanPersistController is either found automatically via class path search
* or can be added programmatically via ServerConfiguration.addEntity().
*
*/
public interface BeanPersistController {
/**
* When there are multiple BeanPersistController's for a given entity type
* this controls the order in which they are executed.
*
* Lowest values are executed first.
*
*
* @return an int used to control the order BeanPersistController's are
* executed
*/
public int getExecutionOrder();
/**
* Return true if this BeanPersistController should be registered for events
* on this entity type.
*/
public boolean isRegisterFor(Class cls);
/**
* Prior to the insert perform some action. Return true if you want the
* default functionality to continue.
*
* Return false if you have completely replaced the insert functionality and
* do not want the default insert to be performed.
*
*/
public boolean preInsert(BeanPersistRequest request);
/**
* Prior to the update perform some action. Return true if you want the
* default functionality to continue.
*
* Return false if you have completely replaced the update functionality and
* do not want the default update to be performed.
*
*/
public boolean preUpdate(BeanPersistRequest request);
/**
* Prior to the delete perform some action. Return true if you want the
* default functionality to continue.
*
* Return false if you have completely replaced the delete functionality and
* do not want the default delete to be performed.
*
*/
public boolean preDelete(BeanPersistRequest request);
/**
* Called after the insert was performed.
*/
public void postInsert(BeanPersistRequest request);
/**
* Called after the update was performed.
*/
public void postUpdate(BeanPersistRequest request);
/**
* Called after the delete was performed.
*/
public void postDelete(BeanPersistRequest request);
/**
* Called after every each bean is fetched and loaded from the database. You
* can override this to derive some information to set to the bean.
*/
public void postLoad(Object bean, Set includedProperties);
}