com.jcorporate.expresso.kernel
Interface Installable

public interface Installable

This interface represents a component that needs to perform install/uninstall work other than recieve straight configuration values. An example of this is a Schema. All Schemas are installable, for example, because tables need to be created, default security set up, etc. And these tables may need to be removed upon uninstallation

Since:

Expresso 5.1

Author:

Michael Rimov

Method Summary

InstallationOptions	getInstallationOptions() This method is used to query the object for any Installation Options.
InstallationOptions	getUninstallOptions() This method is used to query the Installable object for any uninstallation options.
void	install(InstallationOptions installOptions, InstallLog log) Called when the Service Manager installs this component
void	uninstall(InstallationOptions installOptions, InstallLog uninstallLog) Called when the Service Manager uninstalls this component

Method Detail

install

public void install(InstallationOptions installOptions,
                    InstallLog log)
             throws InstallationException

Called when the Service Manager installs this component

Parameters:

log - A 'log4j-like' interface that allows you to output progress in the form of warnings, errors, info messages etc. The underlying implementation is often not log4j.

Throws:

InstallationException

uninstall

public void uninstall(InstallationOptions installOptions,
                      InstallLog uninstallLog)
               throws InstallationException

Called when the Service Manager uninstalls this component

Parameters:

uninstallLog - A 'log4j-like' interface that allows you to output progress in the form of warnings, errors, info messages etc. The underlying implementation is often not log4j.

Throws:

InstallationException

getInstallationOptions

public InstallationOptions getInstallationOptions()

This method is used to query the object for any Installation Options. The implementing component may return null if there are no special options for the job.

Returns:

Created and filled out installation objects or null;

getUninstallOptions

public InstallationOptions getUninstallOptions()

This method is used to query the Installable object for any uninstallation options. The implementing component may return null if there are no special options for the job. Although the 'type' returned is the same, as getInstallOptions(), obviously, their contents are not the same. :)

Returns:

Created and filled out InstallationOptions object or null;