ej.wadapps.multisandbox.application

Class ApplicationInstallerKF

java.lang.Object

ej.wadapps.multisandbox.application.ApplicationInstallerKF

All Implemented Interfaces:

FeatureStateListener, ApplicationInstaller

public class ApplicationInstallerKF
extends Object

The application installer allows to install and uninstall applications in a KF environment.

1. Install: the feature is installed by KF.
2. Uninstall: the feature is uninstalled by KF.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationManagerKF	applicationManager the application manager to update when applications are installed or uninstalled
protected static String	INSTALL Install task name
protected static String	UNINSTALL Uninstall task name

Constructor Summary

Constructors

Constructor and Description
ApplicationInstallerKF(ApplicationManagerKF applicationManager) Creates an application installer on KF.

Method Summary

Modifier and Type	Method and Description
void	addApplicationInstallationListener(ApplicationInstallationListener applicationInstallationListener) Adds an application installation listener.
boolean	canUninstall(Application application) Checks if we can uninstall the given application.
protected void	checkPermission(Application application, String action) Checks that an action on a application is permitted.
ApplicationManagerKF	getApplicationManager() Gets the application manager.
Application	install(InputStream stream) Installs an application from an input stream.
Application	install(InputStream stream, IProgressMonitor monitor) Installs an application from an input stream.
protected Application	installKF(InputStream stream, IProgressMonitor monitor) Installs an application into KF.
protected void	notifyInstall(Application application) Notifies the listener that an application has been installed.
protected void	notifyUninstall(Application application) Notifies the listener that an application has been uninstalled.
void	removeApplicationInstallationListener(ApplicationInstallationListener applicationInstallationListener) Removes an application installation listener.
void	stateChanged(Feature feature, Feature.State previousState) Called when the state of a Feature has changed.
boolean	uninstall(Application application) Uninstalls an application.
boolean	uninstall(Application application, IProgressMonitor monitor) Uninstalls an application.
protected boolean	uninstallKF(Application application, IProgressMonitor monitor) Uninstalls an application from KF.

Methods inherited from class java.lang.Object

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

Field Detail

applicationManager

protected final ApplicationManagerKF applicationManager

the application manager to update when applications are installed or uninstalled

INSTALL

protected static final String INSTALL

Install task name

See Also:

Constant Field Values

UNINSTALL

protected static final String UNINSTALL

Uninstall task name

See Also:

Constant Field Values

Constructor Detail

ApplicationInstallerKF

public ApplicationInstallerKF(ApplicationManagerKF applicationManager)

Creates an application installer on KF.

Parameters:

applicationManager - the applications manager it depends on.

Method Detail

install

public Application install(InputStream stream,
                           IProgressMonitor monitor)
                    throws ApplicationOperationException

Description copied from interface: ApplicationInstaller

Installs an application from an input stream.

Parameters:

stream - the stream containing the application.

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor.

Returns:

the application instance.

Throws:

ApplicationOperationException - if any unexpected errors occur while installing this application.

uninstall

public boolean uninstall(Application application,
                         IProgressMonitor monitor)
                  throws ApplicationOperationException

Description copied from interface: ApplicationInstaller

Uninstalls an application.

Parameters:

application - the application to uninstall.

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor.

Returns:

true if the application has been uninstalled, false otherwise.

Throws:

ApplicationOperationException - if any unexpected errors occur while uninstalling this application.

addApplicationInstallationListener

public void addApplicationInstallationListener(ApplicationInstallationListener applicationInstallationListener)

Description copied from interface: ApplicationInstaller

Adds an application installation listener.

It will be notified for each application installation or uninstallation.

Specified by:

addApplicationInstallationListener in interface ApplicationInstaller

Parameters:

applicationInstallationListener - the listener to add.

canUninstall

public boolean canUninstall(Application application)

Description copied from interface: ApplicationInstaller

Checks if we can uninstall the given application.

Specified by:

canUninstall in interface ApplicationInstaller

Parameters:

application - the application to check.

Returns:

true if the application can been uninstalled, false otherwise.

checkPermission

protected void checkPermission(@Nullable
                               Application application,
                               String action)

Checks that an action on a application is permitted.

Parameters:

application - the application.

action - the action.

getApplicationManager

public ApplicationManagerKF getApplicationManager()

Gets the application manager.

Returns:

the application manager.

install

public Application install(InputStream stream)
                    throws ApplicationOperationException

Description copied from interface: ApplicationInstaller

Installs an application from an input stream.

Specified by:

install in interface ApplicationInstaller

Parameters:

stream - the stream containing the application.

Returns:

the application instance.

Throws:

ApplicationOperationException - if any unexpected errors occur while installing this application.

installKF

protected Application installKF(InputStream stream,
                                IProgressMonitor monitor)
                         throws ApplicationOperationException

Installs an application into KF.

Parameters:

stream - the stream containing the application.

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor.

Returns:

the application instance.

Throws:

ApplicationOperationException - if any unexpected errors occur while installing this application.

notifyInstall

protected void notifyInstall(Application application)

Notifies the listener that an application has been installed.

Parameters:

application - the installed application.

notifyUninstall

protected void notifyUninstall(Application application)

Notifies the listener that an application has been uninstalled.

Parameters:

application - the uninstalled application.

removeApplicationInstallationListener

public void removeApplicationInstallationListener(ApplicationInstallationListener applicationInstallationListener)

Description copied from interface: ApplicationInstaller

Removes an application installation listener.

If the given listener is not registered, nothing is done.

Specified by:

removeApplicationInstallationListener in interface ApplicationInstaller

Parameters:

applicationInstallationListener - the listener to remove.

stateChanged

public void stateChanged(@Nullable
                         Feature feature,
                         @Nullable
                         Feature.State previousState)

Description copied from interface: FeatureStateListener

Called when the state of a Feature has changed.

Specified by:

stateChanged in interface FeatureStateListener

Parameters:

feature - the Feature which state has changed

previousState - the previous state, null if Feature state is Feature.State.INSTALLED

uninstall

public boolean uninstall(Application application)
                  throws ApplicationOperationException

Description copied from interface: ApplicationInstaller

Uninstalls an application.

Specified by:

uninstall in interface ApplicationInstaller

Parameters:

application - the application to uninstall.

Returns:

true if the application has been uninstalled, false otherwise.

Throws:

ApplicationOperationException - if any unexpected errors occur while uninstalling this application.

uninstallKF

protected boolean uninstallKF(Application application,
                              IProgressMonitor monitor)
                       throws ApplicationOperationException

Uninstalls an application from KF.

Parameters:

application - the application to uninstall.

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor.

Returns:

true if the application has been uninstalled, false otherwise.

Throws:

ApplicationOperationException - if any unexpected errors occur while uninstalling this application.