1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/*******************************************************************************
* Copyright (c) 2003, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.osgi.service.pluginconversion;
import java.io.File;
import java.util.Dictionary;
/**
* The interface of the service that allows to convert plugin.xml into manifest.mf
*/
public interface PluginConverter {
/**
* Converts a plug-in/fragment manifest at the given source base location (a directory) and
* generates a corresponding bundle manifest at the given default target locaton (a file).
*
* @param pluginBaseLocation the base location for the plug-in/fragment manifest to be converted
* (a directory, e.g. the plug-in install location)
* @param bundleManifestLocation the location for the bundle manifest to be generated
* (including the file name).
* @param compatibilityManifest a boolean indicating if the manifest should contain headers to run
* in backward compatibility
* @param target a string indicating the version of the runtime for which the manifest generated is targeted
* @param analyseJars a boolean indicating if the code jars of the given plugin must be analysed. When set to false the provided-package har
* @return the generated manifest file location, if a bundle manifest was successfully
* generated (or already existed), <code>null</code> otherwise.
*/
public File convertManifest(File pluginBaseLocation, File bundleManifestLocation, boolean compatibilityManifest, String target, boolean analyseJars) throws PluginConversionException;
/**
* Converts a plug-in/fragment manifest at the given source base location (a directory) and
* generates a corresponding bundle manifest returned as a dictionary.
*
* @param pluginBaseLocation the base location for the plug-in/fragment manifest to be converted
* (a directory, e.g. the plug-in install location)
* @param compatibility a boolean indicating if the manifest should contain headers to run
* in backward compatibility
* @param target a string indicating the version of the runtime for which the manifest generated is targeted
* @param analyseJars a boolean indicating if the code jars of the given plugin must be analysed. When set to false the provided-package har
* @return the generated manifest as a dictionary, if a bundle manifest was successfully
* generated, <code>null</code> otherwise
*/
public Dictionary convertManifest(File pluginBaseLocation, boolean compatibility, String target, boolean analyseJars) throws PluginConversionException;
/**
* Write the dictionary into the specified location.
* @param generationLocation the location for the bundle manifest to be written
* @param manifestToWrite the dictionary to write into generationLocation file
* @param compatibilityManifest a boolean indicating if the file should contain headers to run with
* in backward compatibility
* @throws PluginConversionException if an error occurs while writing the given manifest
*/
public void writeManifest(File generationLocation, Dictionary manifestToWrite, boolean compatibilityManifest) throws PluginConversionException;
}
|
