org.modelio.api.module.lifecycle

Class DefaultModuleLifeCycleHandler

java.lang.Object

org.modelio.api.module.lifecycle.DefaultModuleLifeCycleHandler

All Implemented Interfaces:

IModuleLifeCycleHandler

public class DefaultModuleLifeCycleHandler
extends java.lang.Object
implements IModuleLifeCycleHandler

Default implementation of the IModuleLifeCycleHandler interface.

This default implementation may be inherited by the module developers in order to simplify the code writing of the mdac session.

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected IModule	module

Constructor Summary

Constructors

Constructor and Description
DefaultModuleLifeCycleHandler(IModule module) C'tor initializing the module.

Method Summary

Modifier and Type	Method and Description
void	configurationChanged(java.lang.String pName, java.lang.String oldValue, java.lang.String newValue) Called when a module parameter value has changed.
static boolean	install(java.lang.String modelioPath, java.lang.String installPath) Accepts the installation by default.
boolean	select() Called when the mdac is selected, which corresponds to the user action "Deploy a mdac...".
boolean	start() Called when the mdac is started.
void	stop() Called before the mdac is stopped.
void	unselect() Called when the mdac is deselected from the project.
void	upgrade(Version oldVersion, java.util.Map<java.lang.String,java.lang.String> oldParameters) Called when the mdac is being upgraded from a previous version.

Methods inherited from class java.lang.Object

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

Field Detail

module

protected IModule module

Constructor Detail

DefaultModuleLifeCycleHandler

public DefaultModuleLifeCycleHandler(IModule module)

C'tor initializing the module.

Parameters:

module - the module being constructed.

Method Detail

install

public static boolean install(java.lang.String modelioPath,
                              java.lang.String installPath)
                       throws ModuleException

Accepts the installation by default.

Parameters:

modelioPath - the path of modelio application

installPath - the path where the module archive contents have been expanded.

Returns:

true if the module accepts to be installed false otherwise.

Throws:

ModuleException - when the installation failed.

select

public boolean select()
               throws ModuleException

Description copied from interface: IModuleLifeCycleHandler

Called when the mdac is selected, which corresponds to the user action "Deploy a mdac...".

Specified by:

select in interface IModuleLifeCycleHandler

Returns:

if the mdac accepts to be selected

Throws:

ModuleException - when an error occurs preventing the module from being selected.

start

public boolean start()
              throws ModuleException

Description copied from interface: IModuleLifeCycleHandler

Called when the mdac is started. A mdac is started when:

• the mdac has just been selected
• the project has just been opened
• the mdac has finished to be upgraded from a previous version

Specified by:

start in interface IModuleLifeCycleHandler

Returns:

if the mdac accepts to be started

Throws:

ModuleException - when an error occurs preventing the module from starting.

stop

public void stop()
          throws ModuleException

Description copied from interface: IModuleLifeCycleHandler

Called before the mdac is stopped. A mdac is stopped when:

• the mdac has just been unselected
• the project is being closed
• the mdac is going to be upgraded to another version

Specified by:

stop in interface IModuleLifeCycleHandler

Throws:

ModuleException - when an error occurs preventing the module from stopping.

unselect

public void unselect()
              throws ModuleException

Description copied from interface: IModuleLifeCycleHandler

Called when the mdac is deselected from the project.

Specified by:

unselect in interface IModuleLifeCycleHandler

Throws:

ModuleException - when an error occurs preventing the module from being unselected.

upgrade

public void upgrade(Version oldVersion,
                    java.util.Map<java.lang.String,java.lang.String> oldParameters)
             throws ModuleException

Description copied from interface: IModuleLifeCycleHandler

Called when the mdac is being upgraded from a previous version.

Specified by:

upgrade in interface IModuleLifeCycleHandler

Parameters:

oldVersion - The previous version of the MDAC

oldParameters - The previous list of parameters (key, value)

Throws:

ModuleException - when an error occurs preventing the module from being upgraded.

configurationChanged

public void configurationChanged(java.lang.String pName,
                                 java.lang.String oldValue,
                                 java.lang.String newValue)

Description copied from interface: IModuleLifeCycleHandler

Called when a module parameter value has changed.

Specified by:

configurationChanged in interface IModuleLifeCycleHandler

Parameters:

pName - The name of the parameter whose value changed.

oldValue - The previous value of the parameter value. Can be null.

newValue - The new value of the parameter value. Can be null.