View Javadoc

1   /*
2    * <cvs:source>$Source: /devel/astrogrid/community/common/src/java/org/astrogrid/community/common/database/manager/DatabaseManager.java,v $</cvs:source>
3    * <cvs:author>$Author: dave $</cvs:author>
4    * <cvs:date>$Date: 2004/06/18 13:45:20 $</cvs:date>
5    * <cvs:version>$Revision: 1.6 $</cvs:version>
6    *
7    * <cvs:log>
8    *   $Log: DatabaseManager.java,v $
9    *   Revision 1.6  2004/06/18 13:45:20  dave
10   *   Merged development branch, dave-dev-200406081614, into HEAD
11   *
12   *   Revision 1.5.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.common.database.manager ;
19  
20  import java.rmi.Remote ;
21  import java.rmi.RemoteException ;
22  
23  import org.astrogrid.community.common.service.CommunityService ;
24  import org.astrogrid.community.common.exception.CommunityServiceException ;
25  
26  /***
27   * Interface for our DatabaseManager service.
28   *
29   */
30  public interface DatabaseManager
31      extends Remote, CommunityService
32      {
33      /***
34       * Get the current database name.
35       * @throws CommunityServiceException If there is an server error.
36       * @throws RemoteException If the WebService call fails.
37       *
38       */
39      public String getDatabaseName()
40          throws RemoteException, CommunityServiceException ;
41  
42      /***
43       * Get our JDO configuration resource name.
44       * @throws CommunityServiceException If there is an server error.
45       * @throws RemoteException If the WebService call fails.
46       *
47       */
48      public String getDatabaseConfigResource()
49          throws RemoteException, CommunityServiceException ;
50  
51      /***
52       * Get the database SQL script name.
53       * @throws CommunityServiceException If there is an server error.
54       * @throws RemoteException If the WebService call fails.
55       *
56       */
57      public String getDatabaseScriptResource()
58          throws RemoteException, CommunityServiceException ;
59  
60      /***
61       * Get the database configuration URL.
62       * @throws CommunityServiceException If there is an server error.
63       * @throws RemoteException If the WebService call fails.
64       *
65       */
66      public String getDatabaseConfigUrl()
67          throws RemoteException, CommunityServiceException ;
68  
69      /***
70       * Get the database engine description.
71       * @throws CommunityServiceException If there is an server error.
72       * @throws RemoteException If the WebService call fails.
73       *
74       */
75      public String getDatabaseDescription()
76          throws RemoteException, CommunityServiceException ;
77  
78      /***
79       * Check the database tables.
80       * @throws CommunityServiceException If there is an server error.
81       * @throws RemoteException If the WebService call fails.
82       *
83       */
84      public boolean checkDatabaseTables()
85          throws RemoteException, CommunityServiceException ;
86  
87      /***
88       * Reset our database tables.
89       * @throws CommunityServiceException If there is an server error.
90       * @throws RemoteException If the WebService call fails.
91       *
92       */
93      public void resetDatabaseTables()
94          throws RemoteException, CommunityServiceException ;
95  
96      }