eu.lindenbaum.maven.mojo.app
Class AppupGenerator

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      eu.lindenbaum.maven.ErlangMojo
          eu.lindenbaum.maven.mojo.app.AppupGenerator

All Implemented Interfaces:

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

public final class AppupGenerator
extends ErlangMojo

This Mojo will generate an application upgrade file template for an application. In order to do so all available non-SNAPSHOT versions of the project will be resolved (also from remote repositories). All versions smaller than the current version will be included in the generation. The resulting application upgrade file's location will be prompted on success as well as its content.

The generation algorithm is outlined in the following description:

• Find added modules and add a {load_module, Module} statements for them.
• Find updated modules and invoke the GetAppupDirectiveScript on them.
• Find deleted modules and add a {delete_module, Module} statements for them.

The GetAppupDirectiveScript works as described below:

• Add a {update, Module, supervisor} statement if Module is a supervisor.
• Add a {update, Module} statement if Module exports code_change/3.
• Add a {load_module, Module} statement if Module does not meet the previous conditions.

Since:

2.1.0

Author:

Tobias Schlager

See Also:

http://www.erlang.org/doc/man/appup.html

Goal:

appup

Execute:

phase="package" lifecycle="appup-relup"

Field Summary

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

ROLE

Constructor Summary

AppupGenerator()

Method Summary

protected void

execute(org.apache.maven.plugin.logging.Log log, Properties p) Will be invoked when ErlangMojo.execute() gets invoked on the base class.

Methods inherited from class eu.lindenbaum.maven.ErlangMojo

execute

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

Constructor Detail

AppupGenerator

public AppupGenerator()

Method Detail

execute

protected void execute(org.apache.maven.plugin.logging.Log log,
                       Properties p)
                throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: ErlangMojo

Will be invoked when ErlangMojo.execute() gets invoked on the base class.

Specified by:

execute in class ErlangMojo

Parameters:

log - logger to be used for output logging

p - to be passed by the base class.

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

Mojo.execute()