net.roboconf.plugin.api

Interface PluginInterface

public interface PluginInterface

Author:

Noël - LIG

Method Summary

Modifier and Type	Method and Description
void	deploy(net.roboconf.core.model.beans.Instance instance) Deploys an instance.
String	getPluginName()
void	initialize(net.roboconf.core.model.beans.Instance instance) Initializes the plug-in for this instance.
void	setNames(String applicationName, String rootInstanceName) Sets the names (useful for debug and analyzing logs).
void	start(net.roboconf.core.model.beans.Instance instance) Starts an instance.
void	stop(net.roboconf.core.model.beans.Instance instance) Stops an instance.
void	undeploy(net.roboconf.core.model.beans.Instance instance) Undeploys an instance.
void	update(net.roboconf.core.model.beans.Instance instance, net.roboconf.core.model.beans.Import importChanged, net.roboconf.core.model.beans.Instance.InstanceStatus statusChanged) Updates an instance.

Method Detail

initialize

void initialize(net.roboconf.core.model.beans.Instance instance)
         throws PluginException

Initializes the plug-in for this instance.

As an example, in Puppet, this method install all the modules that will be used by the manifest(s).

Parameters:

instance -

Throws:

PluginException

deploy

void deploy(net.roboconf.core.model.beans.Instance instance)
     throws PluginException

Deploys an instance.

Parameters:

instance - the instance to deploy

Throws:

PluginException

start

void start(net.roboconf.core.model.beans.Instance instance)
    throws PluginException

Starts an instance.

Parameters:

instance - the instance to start

Throws:

PluginException

update

void update(net.roboconf.core.model.beans.Instance instance,
            net.roboconf.core.model.beans.Import importChanged,
            net.roboconf.core.model.beans.Instance.InstanceStatus statusChanged)
     throws PluginException

Updates an instance.

Parameters:

instance - the instance to update

importChanged - the changed import, if any (null if no change)

statusChanged - the new status of the instance that triggered the update, when applicable (null if N/A)

Throws:

PluginException

stop

void stop(net.roboconf.core.model.beans.Instance instance)
   throws PluginException

Stops an instance.

Parameters:

instance - the instance to stop

Throws:

PluginException

undeploy

void undeploy(net.roboconf.core.model.beans.Instance instance)
       throws PluginException

Undeploys an instance.

Parameters:

instance - the instance to undeploy

Throws:

PluginException

setNames

void setNames(String applicationName,
              String rootInstanceName)

Sets the names (useful for debug and analyzing logs).

Parameters:

applicationName - the application name

rootInstanceName - the root instance name

getPluginName

String getPluginName()

Returns:

the plug-in name