View Javadoc

1   /*
2    * <cvs:source>$Source: /devel/astrogrid/community/client/src/java/org/astrogrid/community/client/database/manager/DatabaseManagerDelegate.java,v $</cvs:source>
3    * <cvs:author>$Author: dave $</cvs:author>
4    * <cvs:date>$Date: 2004/06/18 13:45:19 $</cvs:date>
5    * <cvs:version>$Revision: 1.5 $</cvs:version>
6    *
7    * <cvs:log>
8    *   $Log: DatabaseManagerDelegate.java,v $
9    *   Revision 1.5  2004/06/18 13:45:19  dave
10   *   Merged development branch, dave-dev-200406081614, into HEAD
11   *
12   *   Revision 1.4.38.1  2004/06/17 13:38:58  dave
13   *   Tidied up old CVS log entries
14   *
15   * </cvs:log>
16   *
17   */
18  package org.astrogrid.community.client.database.manager ;
19  
20  import org.astrogrid.community.common.service.data.ServiceStatusData ;
21  
22  import org.astrogrid.community.common.database.manager.DatabaseManager ;
23  import org.astrogrid.community.common.exception.CommunityServiceException ;
24  
25  /***
26   * Public interface for our DatabaseManager delegate.
27   * This mirrors the DatabaseManager interface without the RemoteExceptions.
28   * @todo Extend a common base class.
29   *
30   */
31  public interface DatabaseManagerDelegate
32      extends DatabaseManager
33      {
34      /***
35       * Get the current database name.
36       * @throws CommunityServiceException If there is an server error.
37       *
38       */
39      public String getDatabaseName()
40          throws CommunityServiceException ;
41  
42      /***
43       * Get our JDO configuration resource name.
44       * @throws CommunityServiceException If there is an server error.
45       *
46       */
47      public String getDatabaseConfigResource()
48          throws CommunityServiceException ;
49  
50      /***
51       * Get the database SQL script name.
52       * @throws CommunityServiceException If there is an server error.
53       *
54       */
55      public String getDatabaseScriptResource()
56          throws CommunityServiceException ;
57  
58      /***
59       * Get the database configuration URL.
60       * @throws CommunityServiceException If there is an server error.
61       *
62       */
63      public String getDatabaseConfigUrl()
64          throws CommunityServiceException ;
65  
66      /***
67       * Get the database engine description.
68       * @throws CommunityServiceException If there is an server error.
69       *
70       */
71      public String getDatabaseDescription()
72          throws CommunityServiceException ;
73  
74      /***
75       * Check the database tables.
76       * @throws CommunityServiceException If there is an server error.
77       *
78       */
79      public boolean checkDatabaseTables()
80          throws CommunityServiceException ;
81  
82      /***
83       * Reset our database tables.
84       * @throws CommunityServiceException If there is an server error.
85       *
86       */
87      public void resetDatabaseTables()
88          throws CommunityServiceException ;
89  
90      /***
91       * Service health check.
92       * @return ServiceStatusData with details of the Service status.
93       * @throws CommunityServiceException If there is an server error.
94       * @todo Move this to a common base class.
95       *
96       */
97      public ServiceStatusData getServiceStatus()
98          throws CommunityServiceException ;
99  
100     }