com.liferay.portal.lpkg.deployer.LPKGDeployer Maven / Gradle / Ivy
/**
* 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.lpkg.deployer;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
/**
* @author Shuyang Zhou
*/
public interface LPKGDeployer {
/**
* Deploys the LPKG file. This method returns the list of bundles in the
* LPKG file, which includes the LPKG bundle and all its app bundles (if any
* exist). For example, if the LPKG file included four app bundles, then
* five bundles are returned (i.e. one LPKG bundle and four app bundles).
*
* @param bundleContext the context used to install the bundle into the
* OSGi container
* @param lpkgFile the LPKG file to deploy
* @return the LPKG file bundle and its included app bundles
* @throws IOException if an IO failure during installation occurred
*/
public List deploy(BundleContext bundleContext, File lpkgFile)
throws IOException;
/**
* Returns the deployed LPKG bundles together with their app bundles.
*
* @return the map of bundles with the LPKG bundle as the key and the LPKG's
* app bundle list as the value
*/
public Map> getDeployedLPKGBundles();
public InputStream toBundle(File lpkgFile) throws IOException;
}