net.roboconf.plugin.script.internal

Class PluginScript

java.lang.Object

net.roboconf.plugin.script.internal.PluginScript

All Implemented Interfaces:

net.roboconf.plugin.api.PluginInterface

public class PluginScript
extends Object
implements net.roboconf.plugin.api.PluginInterface

The plug-in invokes a script (eg. shell) on every life cycle change.

The action is one of "deploy", "start", "stop", "undeploy" and "update".
Let's take an example with the "start" action to understand the way this plug-in works.

• The plug-in will load scripts/start.sh
• If it is not found, it will try to load templates/start.sh.template
• If it is not found, it will try to load templates/default.sh.template
• If it is not found, the plug-in will do nothing

The default template is used to factorize actions.

Author:

Noël - LIG, Linh-Manh Pham - LIG, Pierre-Yves Gibello - Linagora, Christophe Hamerling - Linagora

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_NAME

Constructor Summary

Constructors

Constructor and Description
PluginScript()

Method Summary

Modifier and Type	Method and Description
void	deploy(net.roboconf.core.model.beans.Instance instance)
protected void	executeScript(File script, net.roboconf.core.model.beans.Instance instance, net.roboconf.core.model.beans.Import importChanged, net.roboconf.core.model.beans.Instance.InstanceStatus statusChanged, String instanceDir)
protected File	generateTemplate(File template, net.roboconf.core.model.beans.Instance instance) Generates a file from the template and the instance.
String	getPluginName()
void	initialize(net.roboconf.core.model.beans.Instance instance)
void	setNames(String applicationName, String scopedInstancePath)
void	start(net.roboconf.core.model.beans.Instance instance)
void	stop(net.roboconf.core.model.beans.Instance instance)
void	undeploy(net.roboconf.core.model.beans.Instance 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)

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

Constant Field Values

Constructor Detail

PluginScript

public PluginScript()

Method Detail

getPluginName

public String getPluginName()

Specified by:

getPluginName in interface net.roboconf.plugin.api.PluginInterface

setNames

public void setNames(String applicationName,
                     String scopedInstancePath)

Specified by:

setNames in interface net.roboconf.plugin.api.PluginInterface

initialize

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

Specified by:

initialize in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

deploy

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

Specified by:

deploy in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

start

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

Specified by:

start in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

update

public 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 net.roboconf.plugin.api.PluginException

Specified by:

update in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

stop

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

Specified by:

stop in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

undeploy

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

Specified by:

undeploy in interface net.roboconf.plugin.api.PluginInterface

Throws:

net.roboconf.plugin.api.PluginException

generateTemplate

protected File generateTemplate(File template,
                                net.roboconf.core.model.beans.Instance instance)
                         throws IOException

Generates a file from the template and the instance.

Parameters:

template -

instance -

Returns:

the generated file

Throws:

IOException

executeScript

protected void executeScript(File script,
                             net.roboconf.core.model.beans.Instance instance,
                             net.roboconf.core.model.beans.Import importChanged,
                             net.roboconf.core.model.beans.Instance.InstanceStatus statusChanged,
                             String instanceDir)
                      throws IOException,
                             InterruptedException

Throws:

IOException

InterruptedException