/**
Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016. All rights reserved.
Contact:
SYSTAP, LLC DBA Blazegraph
2501 Calvert ST NW #106
Washington, DC 20008
licenses@blazegraph.com
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package com.bigdata.journal;
/**
* Interface for a "plug in" that can be registered with a {@link Journal}.
*
* TODO Support at {@link IIndexManager} interface? E.g., for the federation
* as well as the journal.
*
* @author <a href="mailto:thompsonbry@users.sourceforge.net">Bryan Thompson</a>
*/
public interface IPlugIn<M extends IIndexManager, S> {
/**
* Start the service.
*
* @param indexManager
*/
public void startService(M indexManager);
/**
* Stop the service.
*
* @param immediateShutdown
* <code>true</code> if the service should be stopped
* immediately.
*/
public void stopService(boolean immediateShutdown);
/**
* Return the service.
*/
public S getService();
/**
* Return true iff the service is running.
*/
public boolean isRunning();
}