SPI.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library 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 library 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.
 */

package com.liferay.portal.kernel.resiliency.spi;

import com.liferay.portal.kernel.nio.intraband.RegistrationReference;
import com.liferay.portal.kernel.resiliency.mpi.MPI;
import com.liferay.portal.kernel.resiliency.spi.agent.SPIAgent;

import java.io.Serializable;

import java.rmi.Remote;
import java.rmi.RemoteException;

/**
 * @author Shuyang Zhou
 */
public interface SPI extends Remote, Serializable {

	public static final String SPI_INSTANCE_PUBLICATION_KEY =
		"SPI_INSTANCE_PUBLICATION_KEY";

	public void addServlet(
			String contextPath, String docBasePath, String mappingPattern,
			String servletClassName)
		throws RemoteException;

	public void addWebapp(String contextPath, String docBasePath)
		throws RemoteException;

	public void destroy() throws RemoteException;

	public MPI getMPI() throws RemoteException;

	public RegistrationReference getRegistrationReference()
		throws RemoteException;

	public SPIAgent getSPIAgent() throws RemoteException;

	public SPIConfiguration getSPIConfiguration() throws RemoteException;

	public String getSPIProviderName() throws RemoteException;

	public void init() throws RemoteException;

	public boolean isAlive() throws RemoteException;

	public void start() throws RemoteException;

	public void stop() throws RemoteException;

}