org.infinispan.lifecycle.ModuleLifecycle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infinispan-core
Infinispan core module
There is a newer version: 15.1.3.Final
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010 Red Hat Inc. and/or its affiliates and other
 * contributors as indicated by the @author tags. All rights reserved.
 * See the copyright.txt 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.infinispan.lifecycle;

import org.infinispan.configuration.cache.Configuration;
import org.infinispan.configuration.global.GlobalConfiguration;
import org.infinispan.factories.ComponentRegistry;
import org.infinispan.factories.GlobalComponentRegistry;

/**
 * ModuleLifecycle is an internal API hook for delegating lifecycle events to Infinispan sub-modules.
 * 
 * For example, the 'tree' module needs to register specific types with the StreamingMarshaller. The 'query'
 * module needs to register an interceptor with the Cache if the Cache has enabled querying etc etc.
 * 

 * To use this hook, you would need to implement this interface (or extend {@link AbstractModuleLifecycle})
 * and then create a file called infinispan-module.properties in the root of your module's JAR.
 * When using Maven, for example, infinispan-module.properties would typically be in the module's
 * src/main/resources directory so it gets packaged appropriately.
 * 

 * infinispan-module.properties
 * 

 * Currently, the following properties are supported:
 * 

 * infinispan.module.name - the name of the module.  The aim of this property is to identify
 * each individual module, so the contents can be any valid String as long as it does not clash with the
 * module name of another module's life cycle properties. 
 * infinispan.module.lifecycle - the name of the class implementing {@link ModuleLifecycle}.
 * This implementation would typically reside in the module's codebase.
 * 
 * Modules who also have their own configuration (see {@see org.infinispan.configuration}), can access their
 * configuration beans via {@link Configuration#module(Class)}
 *
 * @author Manik Surtani
 * @since 4.0
 */
public interface ModuleLifecycle {

    void cacheManagerStarting(GlobalComponentRegistry gcr, GlobalConfiguration globalConfiguration);

    /**
    * Use {@link #cacheManagerStarting(org.infinispan.factories.GlobalComponentRegistry, org.infinispan.configuration.global.GlobalConfiguration)} instead
    */
    @Deprecated
    void cacheManagerStarting(GlobalComponentRegistry gcr, org.infinispan.config.GlobalConfiguration globalConfiguration);

    void cacheManagerStarted(GlobalComponentRegistry gcr);

    void cacheManagerStopping(GlobalComponentRegistry gcr);

    void cacheManagerStopped(GlobalComponentRegistry gcr);

    void cacheStarting(ComponentRegistry cr, Configuration configuration, String cacheName);

    /**
     * Use {@link #cacheStarting(org.infinispan.factories.ComponentRegistry, org.infinispan.configuration.cache.Configuration, String)} instead
     */
    @Deprecated
    void cacheStarting(ComponentRegistry cr, org.infinispan.config.Configuration configuration, String cacheName);

    void cacheStarted(ComponentRegistry cr, String cacheName);

    void cacheStopping(ComponentRegistry cr, String cacheName);

    void cacheStopped(ComponentRegistry cr, String cacheName);

}