org.astrogrid.community.client.database.manager
Interface DatabaseManagerDelegate

All Superinterfaces:

org.astrogrid.community.common.service.CommunityService, org.astrogrid.community.common.database.manager.DatabaseManager, java.rmi.Remote

All Known Implementing Classes:

DatabaseManagerCoreDelegate, DatabaseManagerMockDelegate, DatabaseManagerSoapDelegate

public interface DatabaseManagerDelegate

extends org.astrogrid.community.common.database.manager.DatabaseManager

Public interface for our DatabaseManager delegate. This mirrors the DatabaseManager interface without the RemoteExceptions.

To Do:

Extend a common base class.

Method Summary

boolean	checkDatabaseTables() Check the database tables.
java.lang.String	getDatabaseConfigResource() Get our JDO configuration resource name.
java.lang.String	getDatabaseConfigUrl() Get the database configuration URL.
java.lang.String	getDatabaseDescription() Get the database engine description.
java.lang.String	getDatabaseName() Get the current database name.
java.lang.String	getDatabaseScriptResource() Get the database SQL script name.
org.astrogrid.community.common.service.data.ServiceStatusData	getServiceStatus() Service health check.
void	resetDatabaseTables() This method is only availabe through the build and test environment.

Method Detail

getDatabaseName

public java.lang.String getDatabaseName()
                                 throws org.astrogrid.community.common.exception.CommunityServiceException

Get the current database name.

Specified by:

getDatabaseName in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

getDatabaseConfigResource

public java.lang.String getDatabaseConfigResource()
                                           throws org.astrogrid.community.common.exception.CommunityServiceException

Get our JDO configuration resource name.

Specified by:

getDatabaseConfigResource in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

getDatabaseScriptResource

public java.lang.String getDatabaseScriptResource()
                                           throws org.astrogrid.community.common.exception.CommunityServiceException

Get the database SQL script name.

Specified by:

getDatabaseScriptResource in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

getDatabaseConfigUrl

public java.lang.String getDatabaseConfigUrl()
                                      throws org.astrogrid.community.common.exception.CommunityServiceException

Get the database configuration URL.

Specified by:

getDatabaseConfigUrl in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

getDatabaseDescription

public java.lang.String getDatabaseDescription()
                                        throws org.astrogrid.community.common.exception.CommunityServiceException

Get the database engine description.

Specified by:

getDatabaseDescription in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

checkDatabaseTables

public boolean checkDatabaseTables()
                            throws org.astrogrid.community.common.exception.CommunityServiceException

Check the database tables.

Specified by:

checkDatabaseTables in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

resetDatabaseTables

public void resetDatabaseTables()
                         throws org.astrogrid.community.common.exception.CommunityServiceException

This method is only availabe through the build and test environment. It is NOT avaliable as a web service interface method in the actual release.

Specified by:

resetDatabaseTables in interface org.astrogrid.community.common.database.manager.DatabaseManager

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

getServiceStatus

public org.astrogrid.community.common.service.data.ServiceStatusData getServiceStatus()
                                                                               throws org.astrogrid.community.common.exception.CommunityServiceException

Service health check.

Specified by:

getServiceStatus in interface org.astrogrid.community.common.service.CommunityService

Returns:

ServiceStatusData with details of the Service status.

Throws:

org.astrogrid.community.common.exception.CommunityServiceException - If there is an server error.

To Do:

Move this to a common base class.