Dekoh platform API

dekoh.portal.install
Class RequiredSQLFilesNotFoundException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.pramati.bfly.vm.api.InstallationException
              extended by dekoh.portal.install.RequiredSQLFilesNotFoundException
All Implemented Interfaces:
Serializable

public class RequiredSQLFilesNotFoundException
extends InstallationException

RequiredSQLFilesNotFoundException is thrown by PortalAppsUpdateHelper class when it cannot load the required SQL files from callback.jar of a given application.

To faclitate internationlization of exception messages, consider adding a static factory method instead of using new RequiredSQLFilesNotFoundException(..). See RequiredSQLFilesNotFoundException.newCreateTablesSQLNotFound(String,String) for an example of such factory method.

Since:
Mar 9, 2007
See Also:
Serialized Form

Constructor Summary
RequiredSQLFilesNotFoundException(String message)
           
RequiredSQLFilesNotFoundException(String message, Throwable cause)
           
RequiredSQLFilesNotFoundException(Throwable cause)
           
 
Method Summary
static RequiredSQLFilesNotFoundException newCreateTablesSQLNotFound(String applicationId, String create_table_script_path)
          Thrown by PortalAppsUpdateHelper, when it cannot find the SQL files required for creating tables in database of a given application.
static RequiredSQLFilesNotFoundException newMigrationSQLFileNotFound(String fileName, String applicationId, String oldVersion, String newVersion)
          Thrown by PortalAppsUpdateHelper, when it cannot find the SQL files required for migrating the database of a given application.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RequiredSQLFilesNotFoundException

public RequiredSQLFilesNotFoundException(String message)

RequiredSQLFilesNotFoundException

public RequiredSQLFilesNotFoundException(String message,
                                         Throwable cause)

RequiredSQLFilesNotFoundException

public RequiredSQLFilesNotFoundException(Throwable cause)
Method Detail

newCreateTablesSQLNotFound

public static RequiredSQLFilesNotFoundException newCreateTablesSQLNotFound(String applicationId,
                                                                           String create_table_script_path)
Thrown by PortalAppsUpdateHelper, when it cannot find the SQL files required for creating tables in database of a given application.

An application can customize its installation process by overriding the method PortalAppsUpdateHelper.handleFirstTimeApplicationDBInstallation(String,com.pramati.bfly.vm.api.Version,java.sql.Connection).

Parameters:
applicationId - as found in component.xml's id element of the application. cannot be null
create_table_script_path -
Returns:
See Also:
For customizing list of SQL files required to migrate the database from one version to another.

newMigrationSQLFileNotFound

public static RequiredSQLFilesNotFoundException newMigrationSQLFileNotFound(String fileName,
                                                                            String applicationId,
                                                                            String oldVersion,
                                                                            String newVersion)
Thrown by PortalAppsUpdateHelper, when it cannot find the SQL files required for migrating the database of a given application.

An application can customize the list of SQL files needed to migrate from one version to other by overriding the method PortalAppsUpdateHelper.getMigrationSQLFileNames(String, String).

Parameters:
fileName - SQL file relative path or as packaged in callback.jar
applicationId - as found in component.xml's id element of the application. cannot be null
oldVersion -
newVersion -
Returns:
See Also:
PortalAppsUpdateHelper.handleFirstTimeApplicationDBInstallation(String,com.pramati.bfly.vm.api.Version,java.sql.Connection)

Dekoh platform API

© 2009 Pramati Technologies - Dekoh - Portal for Developers