Class ManifestConstants


  • public class ManifestConstants
    extends Object
    Constants used in the module manifest. These values define a module.
    Author:
    dochez, Kohsuke Kawaguchi
    • Field Detail

      • BUNDLE_NAME

        public static final String BUNDLE_NAME
        Module name.

        This uniquely identifies the module within modules, but this shouldn't include the version number.

        hk2-module packaging type uses GROUPID.ARTIFACTID for this.

        See Also:
        Constant Field Values
      • MAIN_BUNDLE

        public static final String MAIN_BUNDLE
        Module name that we'll launch.

        This is equivalent of "Main-Class" for us. We'll find ModuleStartup from this module.

        See Also:
        Constant Field Values
      • PKG_EXPORT_NAME

        public static final String PKG_EXPORT_NAME
        Exported package list.

        The value is a comma separated list of packages that are visible to other modules that depend on this module. For example, "com.sun.foobar.spi,com.sun.foobar.abc"

        If this manifest entry doesn't exist, all classes will be exported.

        TODO: expand Maven's hk2-module packaging to generate this.

        See Also:
        Constant Field Values
      • BUNDLE_IMPORT_NAME

        public static final String BUNDLE_IMPORT_NAME
        List of modules that this module depends on.

        The value is a comma separated list of modules names that this module depends on. Whitespaces are allowed before and after commas.

        Maven's hk2-module packaging uses dependency list in POM to fill in this entry. TODO: expand this field to support version specifier.

        See Also:
        Constant Field Values
      • CLASS_PATH

        public static final String CLASS_PATH
        List of other jar files in this module.

        This identifies other jar files in this module, not other modules that this module depends on.

        See jar file specification for the format of the value.

        Maven's hk2-module packaging uses dependency list in POM to fill in this entry.

        See Also:
        CLASS_PATH_ID, Constant Field Values
      • CLASS_PATH_ID

        public static final String CLASS_PATH_ID
        List of other jar files in this module.

        The value is a whitespace separated list of Maven ID of all the dependencies, which is of the form "GROUPID:ARTIFACTID:TYPE[:CLASSIFIER]:VERSION".

        This entry contains essentially the same information as the CLASS_PATH entry, but this enables HK2 to assemble all the required jars by using Maven.

        Maven's hk2-module packaging uses dependency list in POM to fill in this entry.

        See Also:
        CLASS_PATH, Constant Field Values
      • IMPORT_POLICY

        public static final String IMPORT_POLICY
        See ImportPolicy.

        The value is the fully-qualified class name of a class that implements ImportPolicy.

        Maven's hk2-module packaging automatically finds such a class and puts its name, provided that the class has @Service annotation.

        See Also:
        Constant Field Values
      • LIFECYLE_POLICY

        public static final String LIFECYLE_POLICY
        See LifecyclePolicy.

        The value is the fully-qualified class name of a class that implements LifecyclePolicy.

        Maven's hk2-module packaging automatically finds such a class and puts its name, provided that the class has @Service annotation.

        See Also:
        Constant Field Values
      • REPOSITORIES

        public static final String REPOSITORIES

        List of repositories that should be set up before launching the main module

        See Also:
        Constant Field Values