org.cafesip.upgrade
Interface UpgraderListener

All Known Implementing Classes:

UpgraderListenerAdapter

public interface UpgraderListener

An interface that must be implemented by a class in order to be registered as a upgrade listener. If a listener is registered, at every step of the upgrade process, the upgrader utility calls the following methods in the listener object to inform the application of events during the upgrade process. An application can register a listener by setting the property - org.cafesip.upgrade.listener. The listener can be used to perform rollback, execution of custom operations, etc.

Author:

Amit Chatterjee

Method Summary

void	onException(Upgrader upgrader, java.lang.Exception e, int dbPatchLevel, java.io.File file) This method is called when an exception is encountered during the upgrade process.
void	onPostpatch(Upgrader upgrader, int dbPatchLevel, java.io.File file) This method is called after a patch has been applied.
void	onPostupgrade(Upgrader upgrader, int dbPatchLevel) This method is called after the upgrade is completed.
void	onPrepatch(Upgrader upgrader, int dbPatchLevel, java.io.File file) This method is called before a patch is applied.
void	onPreupgrade(Upgrader upgrader, int dbPatchLevel) This method is called before the upgrade process begins.

Method Detail

onPreupgrade

void onPreupgrade(Upgrader upgrader,
                  int dbPatchLevel)

This method is called before the upgrade process begins.

Parameters:

upgrader -

dbPatchLevel -

onPostupgrade

void onPostupgrade(Upgrader upgrader,
                   int dbPatchLevel)

This method is called after the upgrade is completed.

Parameters:

upgrader -

dbPatchLevel -

onPrepatch

void onPrepatch(Upgrader upgrader,
                int dbPatchLevel,
                java.io.File file)

This method is called before a patch is applied.

Parameters:

upgrader -

dbPatchLevel -

file -

onPostpatch

void onPostpatch(Upgrader upgrader,
                 int dbPatchLevel,
                 java.io.File file)

This method is called after a patch has been applied.

Parameters:

upgrader -

dbPatchLevel -

file -

onException

void onException(Upgrader upgrader,
                 java.lang.Exception e,
                 int dbPatchLevel,
                 java.io.File file)

This method is called when an exception is encountered during the upgrade process.

Parameters:

upgrader -

e -

dbPatchLevel -

file -