/*
* JBoss, Home of Professional Open Source.
* Copyright 2015, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* 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.jipijapa.event.spi;
import java.util.Properties;
import org.jipijapa.cache.spi.Classification;
import org.jipijapa.cache.spi.Wrapper;
import org.jipijapa.plugin.spi.PersistenceUnitMetadata;
/**
* lifecycle EventListener
*
* @author Scott Marlow
*/
public interface EventListener {
/**
* called before call to PersistenceProvider.createContainerEntityManagerFactory(PersistenceUnit, Map)
* @param cacheType
* @param persistenceUnitMetadata
*/
void beforeEntityManagerFactoryCreate(Classification cacheType, PersistenceUnitMetadata persistenceUnitMetadata);
/**
* called after call to PersistenceProvider.createContainerEntityManagerFactory(PersistenceUnit, Map)
* @param persistenceUnitMetadata
*/
void afterEntityManagerFactoryCreate(Classification cacheType, PersistenceUnitMetadata persistenceUnitMetadata);
/**
* start cache
*
* @param cacheType
* @param properties
* @return an opaque cache wrapper that is later passed to stopCache
*/
Wrapper startCache(Classification cacheType, Properties properties) throws Exception;
/**
* add dependencies on a cache
*
* @param cacheType
* @param properties
*/
void addCacheDependencies(Classification cacheType, Properties properties);
/**
* Stop cache
*
* @param cacheType
* @param wrapper
* @param skipStop will be true if the cache shouldn't be stopped
*/
void stopCache(Classification cacheType, Wrapper wrapper, boolean skipStop);
}