1 /******************************************************************************* 2 * Copyright (c) 2000, 2017 IBM Corporation and others. 3 * 4 * This program and the accompanying materials 5 * are made available under the terms of the Eclipse Public License 2.0 6 * which accompanies this distribution, and is available at 7 * https://www.eclipse.org/legal/epl-2.0/ 8 * 9 * SPDX-License-Identifier: EPL-2.0 10 * 11 * Contributors: 12 * IBM - Initial API and implementation 13 *******************************************************************************/ 14 package org.eclipse.pde.internal.build; 15 16 import org.eclipse.pde.internal.publishing.Constants; 17 18 /** 19 * Generic constants for this plug-in classes. 20 */ 21 public interface IPDEBuildConstants { 22 23 /** from PlatformURLPluginConnection and PlatformURLFragmentConnection **/ 24 public static final String PLUGIN = "plugin"; //$NON-NLS-1$ 25 public static final String FRAGMENT = "fragment"; //$NON-NLS-1$ 26 public static final String FEATURE = "feature"; //$NON-NLS-1$ 27 public static final String VERSION = "version"; //$NON-NLS-1$ 28 public static final String ID = "id"; //$NON-NLS-1$ 29 public static final String LABEL = "label"; //$NON-NLS-1$ 30 31 /** PDE Core plug-in id */ 32 public static final String PI_BOOT = "org.eclipse.core.boot"; //$NON-NLS-1$ 33 public static final String PI_BOOT_JAR_NAME = "boot.jar"; //$NON-NLS-1$ 34 public static final String PI_PDEBUILD = "org.eclipse.pde.build"; //$NON-NLS-1$ 35 public static final String PI_RUNTIME = "org.eclipse.core.runtime"; //$NON-NLS-1$ 36 public static final String PI_RUNTIME_JAR_NAME = "runtime.jar"; //$NON-NLS-1$ 37 38 /** file names */ 39 public final static String PROPERTIES_FILE = "build.properties"; //$NON-NLS-1$ 40 public final static String PERMISSIONS_FILE = "permissions.properties"; //$NON-NLS-1$ 41 public final static String ABOUT_HTML_FILE = "about.html"; //$NON-NLS-1$ 42 public final static String FEATURE_PROPERTIES_FILE = "feature.properties"; //$NON-NLS-1$ 43 public final static String SOURCE_PLUGIN_ATTRIBUTE = "sourcePlugin"; //$NON-NLS-1$ 44 public final static String MANIFEST_FOLDER = "META-INF"; //$NON-NLS-1$ 45 public final static String MANIFEST = "MANIFEST.MF"; //$NON-NLS-1$ 46 47 public static final String FILE_SCHEME = "file"; //$NON-NLS-1$ 48 public static final String PROFILE = "profile"; //$NON-NLS-1$ 49 public static final String PROFILE_GZ = "profile.gz"; //$NON-NLS-1$ 50 51 // default values 52 public final static String PROPERTY_GENERIC_TARGETS = "genericTargets"; //$NON-NLS-1$ 53 public final static String DEFAULT_BUILD_SCRIPT_FILENAME = "build.xml"; //$NON-NLS-1$ 54 public final static String DEFAULT_FEATURE_LOCATION = "features"; //$NON-NLS-1$ 55 public final static String DEFAULT_FETCH_SCRIPT_FILENAME = "fetch.xml"; //$NON-NLS-1$ 56 public final static String DEFAULT_ASSEMBLE_FILENAME = "assemble.xml"; //$NON-NLS-1$ 57 public final static String DEFAULT_PLUGIN_LOCATION = "plugins"; //$NON-NLS-1$ 58 public final static String DEFAULT_TEMPLATE_SCRIPT_FILENAME = "template.xml"; //$NON-NLS-1$ 59 public final static String GENERIC_VERSION_NUMBER = "0.0.0"; //$NON-NLS-1$ 60 public final static String ANY_STRING = "ANY"; //$NON-NLS-1$ 61 public final static String DEFAULT_ASSEMBLE_NAME = "assemble"; //$NON-NLS-1$ 62 public final static String DEFAULT_ASSEMBLE_ALL = "all.xml"; //$NON-NLS-1$ 63 public final static String DEFAULT_CUSTOM_TARGETS = "customTargets"; //$NON-NLS-1$ 64 public final static String DEFAULT_RETRIEVE_FILENAME_DESCRIPTOR = "retrieve.xml"; //$NON-NLS-1$ 65 public final static String DEFAULT_ISV_DOC_PLUGIN_SUFFIX = "doc.isv"; //$NON-NLS-1$ 66 public final static String DEFAULT_SOURCE_PLUGIN_SUFFIX = "source"; //$NON-NLS-1$ 67 public final static String DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR = "packager.directory.txt"; //$NON-NLS-1$ 68 public final static String DEFAULT_UNZIPPER_FILENAME_DESCRIPTOR = "unzipper.xml"; //$NON-NLS-1$ 69 public final static String DEFAULT_PLUGIN_REPOTAG_FILENAME_DESCRIPTOR = "pluginVersions.properties"; //$NON-NLS-1$ 70 public final static String DEFAULT_FEATURE_REPOTAG_FILENAME_DESCRIPTOR = "featureVersions.properties"; //$NON-NLS-1$ 71 public final static String DEFAULT_SOURCE_REFERENCES_FILENAME_DESCRIPTOR = "sourceReferences.properties"; //$NON-NLS-1$ 72 public final static String DEFAULT_PLUGINS_POSTPROCESSINGSTEPS_FILENAME_DESCRIPTOR = "plugins.postProcessingSteps.properties"; //$NON-NLS-1$ 73 public final static String DEFAULT_FEATURES_POSTPROCESSINGSTEPS_FILENAME_DESCRIPTOR = "features.postProcessingSteps.properties"; //$NON-NLS-1$ 74 public final static String DEFAULT_CUSTOM_BUILD_CALLBACKS_FILE = "customBuildCallbacks.xml"; //$NON-NLS-1$ 75 public final static String DEFAULT_PRODUCT_ROOT_FILES_DIR = "productRootFiles"; //$NON-NLS-1$ 76 77 public final static String DEFAULT_COMPILE_NAME = "compile"; //$NON-NLS-1$ 78 79 public final static String DEFAULT_PLUGIN_VERSION_FILENAME_PREFIX = "finalPluginsVersions"; //$NON-NLS-1$ 80 public final static String DEFAULT_FEATURE_VERSION_FILENAME_PREFIX = "finalFeaturesVersions"; //$NON-NLS-1$ 81 public final static String PROPERTIES_FILE_SUFFIX = ".properties"; //$NON-NLS-1$ 82 83 public final static String[] DEFAULT_SOURCE_FILE_EXTENSIONS = new String[] {"*.java"}; //$NON-NLS-1$ 84 85 // Tag replaced in files 86 public final static String REPLACED_PLUGIN_ID = "PLUGIN_ID"; //$NON-NLS-1$ 87 public final static String REPLACED_PLUGIN_VERSION = "PLUGIN_VERSION"; //$NON-NLS-1$ 88 public final static String REPLACED_FRAGMENT_VERSION = "FRAGMENT_VERSION"; //$NON-NLS-1$ 89 public final static String REPLACED_FRAGMENT_ID = "FRAGMENT_ID"; //$NON-NLS-1$ 90 public final static String REPLACED_PLATFORM_FILTER = "PLATFORM_FILTER"; //$NON-NLS-1$ 91 92 // status constants 93 public final static int EXCEPTION_FEATURE_MISSING = 1; 94 public final static int EXCEPTION_BUILDDIRECTORY_LOCATION_MISSING = 2; 95 public final static int EXCEPTION_MALFORMED_URL = 3; 96 public final static int EXCEPTION_MODEL_PARSE = 4; 97 public final static int EXCEPTION_PLUGIN_MISSING = 5; 98 public final static int EXCEPTION_READ_DIRECTORY = 6; 99 public final static int EXCEPTION_WRITING_SCRIPT = 7; 100 public final static int EXCEPTION_ELEMENT_MISSING = 8; 101 public final static int EXCEPTION_ENTRY_MISSING = 9; 102 public final static int EXCEPTION_READING_FILE = 10; 103 public final static int EXCEPTION_SOURCE_LOCATION_MISSING = 11; 104 public final static int EXCEPTION_WRITING_FILE = 12; 105 public final static int EXCEPTION_INVALID_JAR_ORDER = 13; 106 public final static int EXCEPTION_CLASSPATH_CYCLE = 14; 107 public final static int EXCEPTION_STATE_PROBLEM = 15; 108 public final static int EXCEPTION_GENERIC = 16; 109 public final static int EXCEPTION_FEATURE_PARSE = Constants.EXCEPTION_FEATURE_PARSE; 110 public final static int WARNING_MISSING_SOURCE = 20; 111 public final static int WARNING_ELEMENT_NOT_FETCHED = 21; 112 public final static int EXCEPTION_CONFIG_FORMAT = 22; 113 public final static int EXCEPTION_PRODUCT_FORMAT = 23; 114 public final static int EXCEPTION_PRODUCT_FILE = 24; 115 public final static int WARNING_PLUGIN_ALTERED = 25; 116 public final static int WARNING_OLD_ANT = 26; 117 118 //User object keys. BundleDescription.getUserObject() 119 public final static String IS_COMPILED = "isCompiler"; //$NON-NLS-1$ 120 public final static String PLUGIN_ENTRY = "pluginEntry"; //$NON-NLS-1$ 121 public final static String OLD_BUNDLE_LOCATION = "oldBundleLocation"; //$NON-NLS-1$ 122 public final static String WITH_DOT = "withDot"; //$NON-NLS-1$ 123 124 //Filter properties 125 public final static String OSGI_WS = "osgi.ws"; //$NON-NLS-1$ 126 public final static String OSGI_OS = "osgi.os"; //$NON-NLS-1$ 127 public final static String OSGI_ARCH = "osgi.arch"; //$NON-NLS-1$ 128 public final static String OSGI_NL = "osgi.nl"; //$NON-NLS-1$ 129 130 //Eclipse specific manifest headers 131 public final static String EXTENSIBLE_API = "Eclipse-ExtensibleAPI"; //$NON-NLS-1$ 132 public final static String PATCH_FRAGMENT = "Eclipse-PatchFragment"; //$NON-NLS-1$ 133 public final static String ECLIPSE_SOURCE_BUNDLE = "Eclipse-SourceBundle"; //$NON-NLS-1$ 134 public final static String ECLIPSE_PLATFORM_FILTER = "Eclipse-PlatformFilter"; //$NON-NLS-1$ 135 public final static String ECLIPSE_BUNDLE_SHAPE = Constants.ECLIPSE_BUNDLE_SHAPE; 136 public final static String ECLIPSE_SOURCE_REF = "Eclipse-SourceReferences"; //$NON-NLS-1$ 137 public final static String PDE_SOURCE_REF = "${PDE_SOURCE_REF}"; //$NON-NLS-1$ 138 139 //Some Bundle IDs we care about 140 public final static String BUNDLE_OSGI = "org.eclipse.osgi"; //$NON-NLS-1$ 141 public static final String BUNDLE_EQUINOX_LAUNCHER = Constants.BUNDLE_EQUINOX_LAUNCHER; 142 public static final String BUNDLE_EQUINOX_COMMON = "org.eclipse.equinox.common"; //$NON-NLS-1$ 143 public static final String BUNDLE_CORE_RUNTIME = "org.eclipse.core.runtime"; //$NON-NLS-1$ 144 public static final String BUNDLE_SIMPLE_CONFIGURATOR = "org.eclipse.equinox.simpleconfigurator"; //$NON-NLS-1$ 145 public static final String BUNDLE_DS = "org.eclipse.equinox.ds"; //$NON-NLS-1$ 146 public static final String BUNDLE_FELIX_SCR = "org.apache.felix.scr"; //$NON-NLS-1$ 147 public static final String FEATURE_PLATFORM_LAUNCHERS = "org.eclipse.platform.launchers"; //$NON-NLS-1$ 148 public static final String FEATURE_EQUINOX_EXECUTABLE = "org.eclipse.equinox.executable"; //$NON-NLS-1$ 149 150 // fetch task extension point 151 public final static String EXT_FETCH_TASK_FACTORIES = "org.eclipse.pde.build.fetchFactories"; //$NON-NLS-1$ 152 public final static String ATTR_ID = "id"; //$NON-NLS-1$ 153 public final static String ATTR_CLASS = "class"; //$NON-NLS-1$ 154 public final static String ELEM_FACTORY = "factory"; //$NON-NLS-1$ 155 156 //container feature used in building .product files 157 public final static String CONTAINER_FEATURE = "org.eclipse.pde.build.container.feature"; //$NON-NLS-1$ 158 public final static String UI_CONTAINER_FEATURE = "org.eclipse.pde.container.feature"; //$NON-NLS-1$ 159 160 public final static String PDE_CORE_PREFS = ".settings/org.eclipse.pde.core.prefs"; //$NON-NLS-1$ 161 public final static String JDT_CORE_PREFS = ".settings/org.eclipse.jdt.core.prefs"; //$NON-NLS-1$ 162 public final static String BUNDLE_ROOT_PATH = "BUNDLE_ROOT_PATH"; //$NON-NLS-1$ 163 164 public static final String PROPERTY_RESOLVER_MODE = "osgi.resolverMode"; //$NON-NLS-1$ 165 public static final String PROPERTY_RESOLVE_OPTIONAL = "osgi.resolveOptional"; //$NON-NLS-1$ 166 public static final String VALUE_DEVELOPMENT = "development"; //$NON-NLS-1$ 167 168 public static final String LICENSE_DEFAULT_EXCLUDES = ",.project,build.properties,feature.xml,feature.properties,feature_*.properties"; //$NON-NLS-1$ 169 } 170