org.codehaus.mojo.nbm

Class NetBeansManifestUpdateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.nbm.utils.AbstractNetbeansMojo

org.codehaus.mojo.nbm.AbstractNbmMojo

org.codehaus.mojo.nbm.NetBeansManifestUpdateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="manifest",
      defaultPhase=PROCESS_CLASSES,
      requiresProject=true,
      threadSafe=true,
      requiresDependencyResolution=RUNTIME)
public class NetBeansManifestUpdateMojo
extends AbstractNbmMojo

Goal for generating NetBeans module system specific manifest entries, part of nbm lifecycle/packaging. In order to have the generated manifest picked up by the maven-jar-plugin, one shall add the following configuration snippet to maven-jar-plugin.

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>2.2</version>
        <configuration>
            <useDefaultManifestFile>true</useDefaultManifestFile>
        </configuration>
    </plugin>
 

Author:

Milos Kleint

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.mojo.nbm.AbstractNbmMojo

AbstractNbmMojo.ArtifactResult

Field Summary

Fields

Modifier and Type	Field and Description
protected File	descriptor Deprecated. all content from the module descriptor can be defined as plugin configuration now, will be removed in 4.0 entirely
protected String	moduleType Deployment type of the module, allowed values are normal,eager,autoload, disabled.
protected File	nbmBuildDir NetBeans module assembly build directory.
protected File	nbmJavahelpSource The location of JavaHelp sources for the project.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
NetBeansManifestUpdateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() execute plugin

Methods inherited from class org.codehaus.mojo.nbm.AbstractNbmMojo

createDefaultDescriptor, createDependencyTree, readModuleDescriptor, turnJarToNbmFile

Methods inherited from class org.codehaus.mojo.nbm.utils.AbstractNetbeansMojo

antProject, registerNbmAntTasks

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nbmBuildDir

@Parameter(defaultValue="${project.build.directory}/nbm",
           property="maven.nbm.buildDir")
protected File nbmBuildDir

NetBeans module assembly build directory. directory where the the NetBeans jar and nbm file get constructed.

descriptor

@Parameter(defaultValue="${basedir}/src/main/nbm/module.xml")
protected File descriptor

Deprecated. all content from the module descriptor can be defined as plugin configuration now, will be removed in 4.0 entirely

a NetBeans module descriptor containing dependency information and more

nbmJavahelpSource

@Parameter(defaultValue="${basedir}/src/main/javahelp")
protected File nbmJavahelpSource

The location of JavaHelp sources for the project. The documentation itself is expected to be in the directory structure based on codenamebase of the module. eg. if your codenamebase is "org.netbeans.modules.apisupport", then the actual docs files shall go to ${basedir}/src/main/javahelp/org/netbeans/modules/apisupport/docs. Obsolete as of NetBeans 7.0 with @HelpSetRegistration.

Since:

2.7

moduleType

@Parameter(defaultValue="normal")
protected String moduleType

Deployment type of the module, allowed values are normal,eager,autoload, disabled.

autoload - Such a module is automatically enabled when some other module requires it and automatically disabled otherwise.

eager - This module type gets automatically enabled when all it's dependencies are satisfied. Disabled otherwise.

normal - This is the default value. This kind of module is enabled/disabled manually by the user. It installs enabled.

disabled - This kind of module is enabled/disabled manually by the user. It installs disabled. Since 3.11

For details, see Netbeans Module system docs Since 3.14, for autoload and eager modules, we automatically set AutoUpdate-Show-In-Client manifest entry to false, if not defined already otherwise in the manifest. See issue MNBMODULE-194

Since:

3.8 (3.14 in manifest goal)

Constructor Detail

NetBeansManifestUpdateMojo

public NetBeansManifestUpdateMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

execute plugin

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException