org.xwiki.extension.handler

Interface ExtensionHandler

@Role
public interface ExtensionHandler

Handle extension related tasks depending of the type (install, uninstall, etc...).

Since:

4.0M1

Version:

$Id: d9c3dd8352957f07c51a9b1f24eae1df42764aea $

Method Summary

Methods

Modifier and Type	Method and Description
void	checkInstall(Extension extension, String namespace, Request request) Check if installing the passed extension is allowed.
void	checkUninstall(InstalledExtension extension, String namespace, Request request) Check if uninstalling the passed extension is allowed.
void	initialize(LocalExtension localExtension, String namespace) Initialize the provided local extension (during application startup, re-initialization...).
void	install(LocalExtension localExtension, String namespace, Request request) Install the provided local extension.
void	uninstall(InstalledExtension localExtension, String namespace, Request request) Uninstall the provided local extension.
void	uninstall(LocalExtension localExtension, String namespace, Request request) Deprecated. starting with 5.ORC1 use uninstall(InstalledExtension, String, Request) instead
void	upgrade(Collection<InstalledExtension> previousLocalExtensions, LocalExtension newLocalExtension, String namespace, Request request) Upgrade the provided local extension.
void	upgrade(LocalExtension previousLocalExtension, LocalExtension newLocalExtension, String namespace, Request request) Deprecated. starting with 5.0RC1 use upgrade(Collection, LocalExtension, String, Request)

Method Detail

install

void install(LocalExtension localExtension,
           String namespace,
           Request request)
             throws InstallException

Install the provided local extension.

Parameters:

localExtension - the extension to install

namespace - the namespace where to install the extension

request - extra parameters

Throws:

InstallException - error when trying to install the extension

uninstall

@Deprecated
void uninstall(LocalExtension localExtension,
                        String namespace,
                        Request request)
               throws UninstallException

Deprecated. starting with 5.ORC1 use uninstall(InstalledExtension, String, Request) instead

Uninstall the provided local extension.

Parameters:

localExtension - the extension to uninstall

namespace - the namespace from where to uninstall the extension

request - extra parameters

Throws:

UninstallException - error when trying to uninstall the extension

uninstall

void uninstall(InstalledExtension localExtension,
             String namespace,
             Request request)
               throws UninstallException

Uninstall the provided local extension.

Parameters:

localExtension - the extension to uninstall

namespace - the namespace from where to uninstall the extension

request - extra parameters

Throws:

UninstallException - error when trying to uninstall the extension

Since:

5.0RC1

upgrade

@Deprecated
void upgrade(LocalExtension previousLocalExtension,
                      LocalExtension newLocalExtension,
                      String namespace,
                      Request request)
             throws InstallException

Deprecated. starting with 5.0RC1 use upgrade(Collection, LocalExtension, String, Request)

Upgrade the provided local extension.

Parameters:

previousLocalExtension - the previous installed version of the extension

newLocalExtension - the extension to install

namespace - the namespace from where to uninstall the extension

request - extra parameters

Throws:

InstallException - error when trying to upgrade the extension

upgrade

void upgrade(Collection<InstalledExtension> previousLocalExtensions,
           LocalExtension newLocalExtension,
           String namespace,
           Request request)
             throws InstallException

Upgrade the provided local extension.

Parameters:

previousLocalExtensions - the previous installed versions of the extension

newLocalExtension - the extension to install

namespace - the namespace from where to uninstall the extension

request - extra parameters

Throws:

InstallException - error when trying to upgrade the extension

Since:

5.0RC1

initialize

void initialize(LocalExtension localExtension,
              String namespace)
                throws ExtensionException

Initialize the provided local extension (during application startup, re-initialization...).

Parameters:

localExtension - the extension to install

namespace - the namespace where to install the extension

Throws:

ExtensionException - error when trying to install the extension

checkInstall

void checkInstall(Extension extension,
                String namespace,
                Request request)
                  throws InstallException

Check if installing the passed extension is allowed.

It is generally used to do some non generic checking of whether or not it is possible to install the passed extension (not the right environment, not enough rights, etc.).

Parameters:

extension - the extension to install

namespace - the namespace from where to install

request - extra parameters

Throws:

InstallException - installing the extension will fail

Since:

4.2M2

checkUninstall

void checkUninstall(InstalledExtension extension,
                  String namespace,
                  Request request)
                    throws UninstallException

Check if uninstalling the passed extension is allowed.

It is generally used to do some non generic checking of whether or not it is possible to uninstall the passed extension (not the right environment, not enough rights, etc.).

Parameters:

extension - the extension to uninstall

namespace - the namespace from where to uninstall

request - extra parameters

Throws:

UninstallException - uninstalling the extension will fail

Since:

4.2M2