bundleplugin/src/main/java/aQute/lib/osgi/Constants.java

package aQute.lib.osgi;

import java.nio.charset.*;
import java.util.*;
import java.util.regex.*;

public interface Constants {
	/*
	 * Defined in OSGi
	 */
	/**
	 * @syntax Bundle-ActivationPolicy ::= policy ( ’;’ directive )* policy ::=
	 *         ’lazy’
	 */
	String								BND_ADDXMLTOTEST							= "Bnd-AddXMLToTest";
	String								BUNDLE_ACTIVATIONPOLICY						= "Bundle-ActivationPolicy";
	String								BUNDLE_ACTIVATOR							= "Bundle-Activator";
	String								BUNDLE_BLUEPRINT							= "Bundle-Copyright";
	String								BUNDLE_CATEGORY								= "Bundle-Category";
	String								BUNDLE_CLASSPATH							= "Bundle-ClassPath";
	String								BUNDLE_CONTACTADDRESS						= "Bundle-ContactAddress";
	String								BUNDLE_COPYRIGHT							= "Bundle-Copyright";
	String								BUNDLE_DESCRIPTION							= "Bundle-Description";
	String								BUNDLE_DOCURL								= "Bundle-DocURL";
	String								BUNDLE_ICON									= "Bundle-Icon";
	String								BUNDLE_LICENSE								= "Bundle-License";
	String								BUNDLE_LOCALIZATION							= "Bundle-Localization";
	String								BUNDLE_MANIFESTVERSION						= "Bundle-ManifestVersion";
	String								BUNDLE_NAME									= "Bundle-Name";
	String								BUNDLE_NATIVECODE							= "Bundle-NativeCode";
	String								BUNDLE_REQUIREDEXECUTIONENVIRONMENT			= "Bundle-RequiredExecutionEnvironment";
	String								BUNDLE_SYMBOLICNAME							= "Bundle-SymbolicName";
	String								BUNDLE_UPDATELOCATION						= "Bundle-UpdateLocation";
	String								BUNDLE_VENDOR								= "Bundle-Vendor";
	String								BUNDLE_VERSION								= "Bundle-Version";
	String								DYNAMICIMPORT_PACKAGE						= "DynamicImport-Package";
	String								EXPORT_PACKAGE								= "Export-Package";
	String								EXPORT_SERVICE								= "Export-Service";
	String								FRAGMENT_HOST								= "Fragment-Host";
	String								IMPORT_PACKAGE								= "Import-Package";
	String								IMPORT_SERVICE								= "Import-Service";
	String								PROVIDE_CAPABILITY							= "Provide-Capability";
	String								REQUIRE_BUNDLE								= "Require-Bundle";
	String								REQUIRE_CAPABILITY							= "Require-Capability";
	String								SERVICE_COMPONENT							= "Service-Component";

	String								PRIVATE_PACKAGE								= "Private-Package";
	String								IGNORE_PACKAGE								= "Ignore-Package";
	String								INCLUDE_RESOURCE							= "Include-Resource";
	String								CONDITIONAL_PACKAGE							= "Conditional-Package";
	String								BND_LASTMODIFIED							= "Bnd-LastModified";
	String								CREATED_BY									= "Created-By";
	String								TOOL										= "Tool";
	String								TESTCASES									= "Test-Cases";
	String								SIGNATURE_TEST								= "-signaturetest";

	String								headers[]									= {
			BUNDLE_ACTIVATOR, BUNDLE_CONTACTADDRESS, BUNDLE_COPYRIGHT, BUNDLE_DESCRIPTION,
			BUNDLE_DOCURL, BUNDLE_LOCALIZATION, BUNDLE_NATIVECODE, BUNDLE_VENDOR, BUNDLE_VERSION,
			BUNDLE_LICENSE, BUNDLE_CLASSPATH, SERVICE_COMPONENT, EXPORT_PACKAGE, IMPORT_PACKAGE,
			BUNDLE_LOCALIZATION, BUNDLE_MANIFESTVERSION, BUNDLE_NAME, BUNDLE_NATIVECODE,
			BUNDLE_REQUIREDEXECUTIONENVIRONMENT, BUNDLE_SYMBOLICNAME, BUNDLE_VERSION,
			FRAGMENT_HOST, PRIVATE_PACKAGE, IGNORE_PACKAGE, INCLUDE_RESOURCE, REQUIRE_BUNDLE,
			IMPORT_SERVICE, EXPORT_SERVICE, CONDITIONAL_PACKAGE, BND_LASTMODIFIED, TESTCASES,
			SIGNATURE_TEST, REQUIRE_CAPABILITY, PROVIDE_CAPABILITY					};

	String								BUILDPATH									= "-buildpath";
	String								BUILDPACKAGES								= "-buildpackages";
	String								BUMPPOLICY									= "-bumppolicy";
	String								CONDUIT										= "-conduit";
	String								COMPILER_SOURCE								= "-source";
	String								COMPILER_TARGET								= "-target";
	String								DEPENDSON									= "-dependson";
	String								DEPLOY										= "-deploy";
	String								DEPLOYREPO									= "-deployrepo";
	String								DIGESTS										= "-digests";
	String								DSANNOTATIONS								= "-dsannotations";
	String								DONOTCOPY									= "-donotcopy";
	String								DEBUG										= "-debug";
	String								EXPORT_CONTENTS								= "-exportcontents";
	String								FAIL_OK										= "-failok";
	String								INCLUDE										= "-include";
	String								INCLUDERESOURCE								= "-includeresource";
	String								MAKE										= "-make";
	String								METATYPE									= "-metatype";
	String								MANIFEST									= "-manifest";
	String								SAVEMANIFEST								= "-savemanifest";
	String								NAMESECTION									= "-namesection";
	String								NODEFAULTVERSION							= "-nodefaultversion";
	String								NOEXTRAHEADERS								= "-noextraheaders";
	String								NOMANIFEST									= "-nomanifest";
	String								NOUSES										= "-nouses";
	@Deprecated
	String								NOPE										= "-nope";
	String								NOBUNDLES									= "-nobundles";
	String								PEDANTIC									= "-pedantic";
	String								PLUGIN										= "-plugin";
	String								PLUGINPATH									= "-pluginpath";
	String								POM											= "-pom";
	String								RELEASEREPO									= "-releaserepo";
	String								REMOVEHEADERS								= "-removeheaders";
	String								RESOURCEONLY								= "-resourceonly";
	String								SOURCES										= "-sources";
	String								SOURCEPATH									= "-sourcepath";
	String								SUB											= "-sub";
	String								RUNPROPERTIES								= "-runproperties";
	String								RUNSYSTEMPACKAGES							= "-runsystempackages";
	String								RUNBUNDLES									= "-runbundles";
	String								RUNPATH										= "-runpath";
	String								RUNSTORAGE									= "-runstorage";
	String								RUNBUILDS									= "-runbuilds";
	String								RUNPATH_MAIN_DIRECTIVE						= "main:";
	String								RUNPATH_LAUNCHER_DIRECTIVE					= "launcher:";
	String								RUNVM										= "-runvm";
	String								RUNTRACE									= "-runtrace";
	String								RUNFRAMEWORK								= "-runframework";
	String								RUNTIMEOUT									= "-runtimeout";
	String								SNAPSHOT									= "-snapshot";
	String								RUNFRAMEWORK_SERVICES						= "services";
	String								RUNFRAMEWORK_NONE							= "none";
	String								REPORTNEWER									= "-reportnewer";
	String								SIGN										= "-sign";
	String								TESTPACKAGES								= "-testpackages";
	String								TESTREPORT									= "-testreport";
	String								TESTPATH									= "-testpath";
	String								TESTCONTINUOUS								= "-testcontinuous";
	String								UNDERTEST									= "-undertest";
	String								VERBOSE										= "-verbose";
	@Deprecated
	String								VERSIONPOLICY_IMPL							= "-versionpolicy-impl";
	@Deprecated
	String								VERSIONPOLICY_USES							= "-versionpolicy-uses";
	String								PROVIDER_POLICY								= "-provider-policy";
	String								CONSUMER_POLICY								= "-consumer-policy";
	@Deprecated
	String								VERSIONPOLICY								= "-versionpolicy";
	String								WAB											= "-wab";
	String								WABLIB										= "-wablib";
	String								REQUIRE_BND									= "-require-bnd";

	// Deprecated
	String								CLASSPATH									= "-classpath";
	String								OUTPUT										= "-output";

	String								options[]									= {BUILDPATH,
			BUMPPOLICY, CONDUIT, CLASSPATH, CONSUMER_POLICY, DEPENDSON, DONOTCOPY, EXPORT_CONTENTS,
			FAIL_OK, INCLUDE, INCLUDERESOURCE, MAKE, MANIFEST, NOEXTRAHEADERS, NOUSES, NOBUNDLES,
			PEDANTIC, PLUGIN, POM, PROVIDER_POLICY, REMOVEHEADERS, RESOURCEONLY, SOURCES,
			SOURCEPATH, SOURCES, SOURCEPATH, SUB, RUNBUNDLES, RUNPATH, RUNSYSTEMPACKAGES,
			RUNPROPERTIES, REPORTNEWER, UNDERTEST, TESTPATH, TESTPACKAGES, TESTREPORT, VERBOSE,
			NOMANIFEST, DEPLOYREPO, RELEASEREPO, SAVEMANIFEST, RUNVM, WAB, WABLIB, RUNFRAMEWORK,
			RUNTRACE, TESTCONTINUOUS, SNAPSHOT, NAMESECTION, DIGESTS, DSANNOTATIONS				};

	// Ignore bundle specific headers. These bundles do not make
	// a lot of sense to inherit
	String[]							BUNDLE_SPECIFIC_HEADERS						= new String[] {
			INCLUDE_RESOURCE, BUNDLE_ACTIVATOR, BUNDLE_CLASSPATH, BUNDLE_NAME, BUNDLE_NATIVECODE,
			BUNDLE_SYMBOLICNAME, IMPORT_PACKAGE, EXPORT_PACKAGE, DYNAMICIMPORT_PACKAGE,
			FRAGMENT_HOST, REQUIRE_BUNDLE, PRIVATE_PACKAGE, EXPORT_CONTENTS, TESTCASES, NOMANIFEST,
			SIGNATURE_TEST, WAB, WABLIB, REQUIRE_CAPABILITY, PROVIDE_CAPABILITY, DSANNOTATIONS, SERVICE_COMPONENT		};

	char								DUPLICATE_MARKER							= '~';
	String								SPECIFICATION_VERSION						= "specification-version";
	String								SPLIT_PACKAGE_DIRECTIVE						= "-split-package:";
	String								IMPORT_DIRECTIVE							= "-import:";
	String								NO_IMPORT_DIRECTIVE							= "-noimport:";
	String								REMOVE_ATTRIBUTE_DIRECTIVE					= "-remove-attribute:";
	String								LIB_DIRECTIVE								= "lib:";
	String								NOANNOTATIONS								= "-noannotations";
	String								COMMAND_DIRECTIVE							= "command:";
	String								USES_DIRECTIVE								= "uses:";
	String								MANDATORY_DIRECTIVE							= "mandatory:";
	String								INCLUDE_DIRECTIVE							= "include:";
	String								PROVIDE_DIRECTIVE							= "provide:";
	String								EXCLUDE_DIRECTIVE							= "exclude:";
	String								PRESENCE_DIRECTIVE							= "presence:";
	String								PRIVATE_DIRECTIVE							= "private:";
	String								SINGLETON_DIRECTIVE							= "singleton:";
	String								EXTENSION_DIRECTIVE							= "extension:";
	String								VISIBILITY_DIRECTIVE						= "visibility:";
	String								FRAGMENT_ATTACHMENT_DIRECTIVE				= "fragment-attachment:";
	String								RESOLUTION_DIRECTIVE						= "resolution:";
	String								PATH_DIRECTIVE								= "path:";
	String								SIZE_ATTRIBUTE								= "size";
	String								LINK_ATTRIBUTE								= "link";
	String								NAME_ATTRIBUTE								= "name";
	String								DESCRIPTION_ATTRIBUTE						= "description";
	String								OSNAME_ATTRIBUTE							= "osname";
	String								OSVERSION_ATTRIBUTE							= "osversion";
	String								PROCESSOR_ATTRIBUTE							= "processor";
	String								LANGUAGE_ATTRIBUTE							= "language";
	String								SELECTION_FILTER_ATTRIBUTE					= "selection-filter";
	String								BLUEPRINT_WAIT_FOR_DEPENDENCIES_ATTRIBUTE	= "blueprint.wait-for-dependencies";
	String								BLUEPRINT_TIMEOUT_ATTRIBUTE					= "blueprint.timeout";
	String								VERSION_ATTRIBUTE							= "version";
	String								BUNDLE_SYMBOLIC_NAME_ATTRIBUTE				= "bundle-symbolic-name";
	String								BUNDLE_VERSION_ATTRIBUTE					= "bundle-version";
	String								FROM_DIRECTIVE								= "from:";

	String								KEYSTORE_LOCATION_DIRECTIVE					= "keystore:";
	String								KEYSTORE_PROVIDER_DIRECTIVE					= "provider:";
	String								KEYSTORE_PASSWORD_DIRECTIVE					= "password:";
	String								SIGN_PASSWORD_DIRECTIVE						= "sign-password:";

	String								NONE										= "none";

	String								directives[]								= {
			SPLIT_PACKAGE_DIRECTIVE, NO_IMPORT_DIRECTIVE, IMPORT_DIRECTIVE, RESOLUTION_DIRECTIVE,
			INCLUDE_DIRECTIVE, USES_DIRECTIVE, EXCLUDE_DIRECTIVE, KEYSTORE_LOCATION_DIRECTIVE,
			KEYSTORE_PROVIDER_DIRECTIVE, KEYSTORE_PASSWORD_DIRECTIVE, SIGN_PASSWORD_DIRECTIVE,
			COMMAND_DIRECTIVE, NOANNOTATIONS, LIB_DIRECTIVE, RUNPATH_LAUNCHER_DIRECTIVE,
			FROM_DIRECTIVE, PRIVATE_DIRECTIVE

																					// TODO
																					};

	String								USES_USES									= "<<USES>>";
	String								CURRENT_USES								= "@uses";
	String								IMPORT_REFERENCE							= "reference";
	String								IMPORT_PRIVATE								= "private";
	String[]							importDirectives							= {
			IMPORT_REFERENCE, IMPORT_PRIVATE										};

	static final Pattern				VALID_PROPERTY_TYPES						= Pattern
																							.compile("(String|Long|Double|Float|Integer|Byte|Character|Boolean|Short)");

	String								DEFAULT_BND_EXTENSION						= ".bnd";
	String								DEFAULT_JAR_EXTENSION						= ".jar";
	String								DEFAULT_BAR_EXTENSION						= ".bar";
	String								DEFAULT_BNDRUN_EXTENSION					= ".bndrun";
	String[]							METAPACKAGES								= {"META-INF",
			"OSGI-INF", "OSGI-OPT"													};

	String								CURRENT_VERSION								= "@";
	String								CURRENT_PACKAGE								= "@package";

	String								BUILDFILES									= "buildfiles";

	String								EMPTY_HEADER								= "<<EMPTY>>";

	String								EMBEDDED_REPO								= "/embedded-repo.jar";
	String								LAUNCHER_PLUGIN								= "Launcher-Plugin";
	String								TESTER_PLUGIN								= "Tester-Plugin";

	String								DEFAULT_LAUNCHER_BSN						= "biz.aQute.launcher";
	String								DEFAULT_TESTER_BSN							= "biz.aQute.junit";

	String								DEFAULT_DO_NOT_COPY							= "CVS|\\.svn|\\.git|\\.DS_Store";

	Charset								DEFAULT_CHARSET								= Charset
																							.forName("UTF8");
	String								VERSION_FILTER								= "version";
	String								PROVIDER_TYPE_DIRECTIVE						= "x-provider-type:";

	/**
	 * Component constants
	 */
	public final static String			NAMESPACE_STEM								= "http://www.osgi.org/xmlns/scr";
	public final static String			JIDENTIFIER									= "<<identifier>>";
	public final static String			COMPONENT_NAME								= "name:";
	public final static String			COMPONENT_FACTORY							= "factory:";
	public final static String			COMPONENT_SERVICEFACTORY					= "servicefactory:";
	public final static String			COMPONENT_IMMEDIATE							= "immediate:";
	public final static String			COMPONENT_ENABLED							= "enabled:";
	public final static String			COMPONENT_DYNAMIC							= "dynamic:";
	public final static String			COMPONENT_MULTIPLE							= "multiple:";
	public final static String			COMPONENT_PROVIDE							= "provide:";
	public final static String			COMPONENT_OPTIONAL							= "optional:";
	public final static String			COMPONENT_PROPERTIES						= "properties:";
	public final static String			COMPONENT_IMPLEMENTATION					= "implementation:";
	public final static String			COMPONENT_DESIGNATE							= "designate:";
	public final static String			COMPONENT_DESIGNATEFACTORY					= "designateFactory:";
	public final static String			COMPONENT_DESCRIPTORS						= ".descriptors:";

	// v1.1.0
	public final static String			COMPONENT_VERSION							= "version:";
	public final static String			COMPONENT_CONFIGURATION_POLICY				= "configuration-policy:";
	public final static String			COMPONENT_MODIFIED							= "modified:";
	public final static String			COMPONENT_ACTIVATE							= "activate:";
	public final static String			COMPONENT_DEACTIVATE						= "deactivate:";

	final static Map<String, String>	EMPTY										= Collections
																							.emptyMap();

	public final static String[]		componentDirectives							= new String[] {
			COMPONENT_FACTORY, COMPONENT_IMMEDIATE, COMPONENT_ENABLED, COMPONENT_DYNAMIC,
			COMPONENT_MULTIPLE, COMPONENT_PROVIDE, COMPONENT_OPTIONAL, COMPONENT_PROPERTIES,
			COMPONENT_IMPLEMENTATION, COMPONENT_SERVICEFACTORY, COMPONENT_VERSION,
			COMPONENT_CONFIGURATION_POLICY, COMPONENT_MODIFIED, COMPONENT_ACTIVATE,
			COMPONENT_DEACTIVATE, COMPONENT_NAME, COMPONENT_DESCRIPTORS, COMPONENT_DESIGNATE,
			COMPONENT_DESIGNATEFACTORY												};

	public final static Set<String>		SET_COMPONENT_DIRECTIVES					= new HashSet<String>(
																							Arrays.asList(componentDirectives));

	public final static Set<String>		SET_COMPONENT_DIRECTIVES_1_1				= //
																					new HashSet<String>(
																							Arrays.asList(
																									COMPONENT_VERSION,
																									COMPONENT_CONFIGURATION_POLICY,
																									COMPONENT_MODIFIED,
																									COMPONENT_ACTIVATE,
																									COMPONENT_DEACTIVATE));

}