org.xwiki.extension.handler

Interface ExtensionHandlerManager

@Role
public interface ExtensionHandlerManager

Used as proxy behind all extension handlers.

Since:

4.0M1

Version:

$Id: dae92183d703e26f597e7609442a2c62fc41b629 $

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(LocalExtension localExtension, String namespace) Initialize the provided local extension (during application startup, reinitialization...).
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. since 5.0RC1 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. since 5.0RC1 use upgrade(Collection, LocalExtension, String, Request) instead

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. since 5.0RC1 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

upgrade

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

Deprecated. since 5.0RC1 use upgrade(Collection, LocalExtension, String, Request) instead

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

initialize

void initialize(LocalExtension localExtension,
              String namespace)
                throws ExtensionException

Initialize the provided local extension (during application startup, reinitialization...).

Parameters:

localExtension - the extension to install

namespace - the namespace where to install the extension

Throws:

ExtensionException - error when trying to initialize the extension