org.nuxeo.connect.update.impl.task
Class AbstractTask

java.lang.Object
  org.nuxeo.connect.update.impl.task.AbstractTask

All Implemented Interfaces:

org.nuxeo.connect.update.task.Task

Direct Known Subclasses:

AntTask, CommandsTask

public abstract class AbstractTask
extends Object
implements org.nuxeo.connect.update.task.Task

Author:

Bogdan Stefanescu

Field Summary

static String	ENV_BUNDLES
static String	ENV_CONFIG
static String	ENV_EAR Set only on JBoss - the EAR root directory path
static String	ENV_HOME
static String	ENV_HOSTAPP_NAME The host application name.
static String	ENV_HOSTAPP_VERSION The host application version
static String	ENV_LIB
static String	ENV_SERVER_HOME
static String	ENV_SYSLIB
static String	ENV_TEMPLATES
static String	ENV_TIMESTAMP
static String	PKG_ID
static String	PKG_NAME
static String	PKG_ROOT
static String	PKG_VERSION

Method Summary

abstract void	doValidate(org.nuxeo.connect.update.ValidationStatus status)
File	getFile(String key) Get a file given its key in the environment map.
org.nuxeo.connect.update.LocalPackage	getPackage()
void	initialize(org.nuxeo.connect.update.LocalPackage pkg, boolean restart)
abstract boolean	isInstallTask()
boolean	isRestartRequired()
void	rollback()
void	run(Map<String,String> params)
void	setRestartRequired(boolean isRestartRequired)
org.nuxeo.connect.update.ValidationStatus	validate()

Methods inherited from class java.lang.Object

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

Field Detail

PKG_ID

public static final String PKG_ID

See Also:

Constant Field Values

PKG_NAME

public static final String PKG_NAME

See Also:

Constant Field Values

PKG_VERSION

public static final String PKG_VERSION

See Also:

Constant Field Values

PKG_ROOT

public static final String PKG_ROOT

See Also:

Constant Field Values

ENV_HOME

public static final String ENV_HOME

See Also:

Constant Field Values

ENV_SERVER_HOME

public static final String ENV_SERVER_HOME

Since:

5.4.3

See Also:

Constant Field Values

ENV_EAR

public static final String ENV_EAR

Set only on JBoss - the EAR root directory path

See Also:

Constant Field Values

ENV_LIB

public static final String ENV_LIB

See Also:

Constant Field Values

ENV_SYSLIB

public static final String ENV_SYSLIB

See Also:

Constant Field Values

ENV_BUNDLES

public static final String ENV_BUNDLES

See Also:

Constant Field Values

ENV_CONFIG

public static final String ENV_CONFIG

See Also:

Constant Field Values

ENV_TEMPLATES

public static final String ENV_TEMPLATES

Since:

5.4.3

See Also:

Constant Field Values

ENV_TIMESTAMP

public static final String ENV_TIMESTAMP

See Also:

Constant Field Values

ENV_HOSTAPP_NAME

public static final String ENV_HOSTAPP_NAME

The host application name.

See Also:

Environment.getHostApplicationName(), Constant Field Values

ENV_HOSTAPP_VERSION

public static final String ENV_HOSTAPP_VERSION

The host application version

See Also:

Environment.getHostApplicationVersion(), Constant Field Values

Method Detail

isInstallTask

public abstract boolean isInstallTask()

initialize

public void initialize(org.nuxeo.connect.update.LocalPackage pkg,
                       boolean restart)
                throws org.nuxeo.connect.update.PackageException

Specified by:

initialize in interface org.nuxeo.connect.update.task.Task

Throws:

org.nuxeo.connect.update.PackageException

getFile

public File getFile(String key)

Get a file given its key in the environment map. If no key exists then null is returned.

Parameters:

key -

isRestartRequired

public boolean isRestartRequired()

Specified by:

isRestartRequired in interface org.nuxeo.connect.update.task.Task

getPackage

public org.nuxeo.connect.update.LocalPackage getPackage()

Specified by:

getPackage in interface org.nuxeo.connect.update.task.Task

run

public void run(Map<String,String> params)
         throws org.nuxeo.connect.update.PackageException

Specified by:

run in interface org.nuxeo.connect.update.task.Task

Throws:

org.nuxeo.connect.update.PackageException

rollback

public void rollback()
              throws org.nuxeo.connect.update.PackageException

Specified by:

rollback in interface org.nuxeo.connect.update.task.Task

Throws:

org.nuxeo.connect.update.PackageException

setRestartRequired

public void setRestartRequired(boolean isRestartRequired)

Specified by:

setRestartRequired in interface org.nuxeo.connect.update.task.Task

validate

public org.nuxeo.connect.update.ValidationStatus validate()
                                                   throws org.nuxeo.connect.update.PackageException

Specified by:

validate in interface org.nuxeo.connect.update.task.Task

Throws:

org.nuxeo.connect.update.PackageException

doValidate

public abstract void doValidate(org.nuxeo.connect.update.ValidationStatus status)
                         throws org.nuxeo.connect.update.PackageException

Throws:

org.nuxeo.connect.update.PackageException