cst.adminTool.persistenceLayer
Class DemonstrationAdminService

java.lang.Object
  cst.common.persistenceLayer.AbstractDemonstrationService
      cst.adminTool.persistenceLayer.DemonstrationAdminService

All Implemented Interfaces:

AdminServiceAPI, CSTServiceAPI

public class DemonstrationAdminService
extends AbstractDemonstrationService
implements AdminServiceAPI

Provides an in-memory version of the administration service that is used principally for demonstration and testing purposes. CST is designed so that the Administration Tool GUI is unaware of how a repository is implemented. When users run the demonstration version of their service specification, the DemonstrationToolSuite spawns copies of both DemonstrationAdminService and DemonstrationLoggingService. Both services rely on an instance of the virtual database DemonstrationDB

The In-memory database is intended to provide a simple version of the repository which can serve two purposes:

• demonstrate generated forms to end-users to help them elicit feedback on a prototype. Note that the prototype can be run without requiring installation of MySQL. This is useful if demos are run off portable USB drives
• testing. All test suites can be run against both in-memory and MySQL implementations of the data repository. Testing in this way helps to identify the origin of bugs.

 Copyright 2010 Medical Research Council Unit for Lifelong Health and Ageing
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
      http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software 
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.  
 

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Field Summary

Fields inherited from class cst.common.persistenceLayer.AbstractDemonstrationService

adminUser, demonstrationDB, guest, recognisedUsers, sessionProperties

Constructor Summary

DemonstrationAdminService(DemonstrationDB demonstrationDB)


Method Summary

void	addUser(User adminUser, User user) add a user to the list of registered users of the system.
void	changeAdministratorPassword(User candidateAdminUser, java.lang.String candidatePassword) TODO - this method should probably be changed.
void	checkRepositoryIsSynchronised(User adminUser)
void	clearChanges(User adminUser) removes all records that describe changes made to activity data.
void	clearDatabase(User adminUser) produces an empty database.
void	clearUsers(User adminUser) removes all users from the list of registered users.
void	createDatabase(User adminUser) creates a database according to settings specified in the configuration file the end users choose when they start the Administration Tool.
boolean	databaseExists(User adminUser) determines whether the database described in the configuration file at startup exists or not.
void	deleteDatabase(User adminUser) deletes the database described in the configuration file end users choose when they start the Administration Tool.
void	deleteUser(User adminUser, User user) deletes a user from the registry of known users.
User	getAdministratorID()
java.util.ArrayList<User>	getRegisteredUsers(User admin) returns a collection of registered users for the system.
java.util.ArrayList<TrialSubjectModel>	getSubjectAttributeData(User adminUser) Provides all the subject attribute data that is needed to uniquely identify and filter subjects.
TrialSubjectModel	getTrialSubjectModel(User user, java.lang.String identifier)
void	importTrialSubjectModels(User adminUser, java.util.ArrayList<TrialSubjectModel> trialSubjectModelsToImport) imports a collection of trial subject model records into the data repository.
void	synchroniseRepository(User adminUser) ensures that every activity and activity step defined in the configuration file specied at startup has a corresponding entry in the data repository.
void	updateUser(User adminUser, User user) update the details of an existing user
boolean	userExists(User adminUser, java.lang.String userID) determines whether a given userID exists in the collection of registered users
boolean	validateAdministrator(User candidateAdminUser) determine whether a given user is the administrator or not
void	validateUser(User user)

Methods inherited from class cst.common.persistenceLayer.AbstractDemonstrationService

checkRepositoryIsSynchronised, initialise, isValidUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cst.common.businessLayer.CSTServiceAPI

checkRepositoryIsSynchronised, initialise

Constructor Detail

DemonstrationAdminService

public DemonstrationAdminService(DemonstrationDB demonstrationDB)

Method Detail

createDatabase

public void createDatabase(User adminUser)
                    throws CSTException

Description copied from interface: AdminServiceAPI

creates a database according to settings specified in the configuration file the end users choose when they start the Administration Tool.

Specified by:

createDatabase in interface AdminServiceAPI

Throws:

CSTException

clearDatabase

public void clearDatabase(User adminUser)
                   throws CSTException

Description copied from interface: AdminServiceAPI

produces an empty database. This method exists mainly to service testing efforts

Specified by:

clearDatabase in interface AdminServiceAPI

Throws:

CSTException

clearChanges

public void clearChanges(User adminUser)
                  throws CSTException

Description copied from interface: AdminServiceAPI

removes all records that describe changes made to activity data.

Specified by:

clearChanges in interface AdminServiceAPI

Throws:

CSTException

clearUsers

public void clearUsers(User adminUser)
                throws CSTException

Description copied from interface: AdminServiceAPI

removes all users from the list of registered users.

Specified by:

clearUsers in interface AdminServiceAPI

Throws:

CSTException

deleteDatabase

public void deleteDatabase(User adminUser)
                    throws CSTException

Description copied from interface: AdminServiceAPI

deletes the database described in the configuration file end users choose when they start the Administration Tool.

Specified by:

deleteDatabase in interface AdminServiceAPI

Throws:

CSTException

getSubjectAttributeData

public java.util.ArrayList<TrialSubjectModel> getSubjectAttributeData(User adminUser)
                                                               throws CSTException

Description copied from interface: AdminServiceAPI

Provides all the subject attribute data that is needed to uniquely identify and filter subjects. Subject attribute data are stored in the system to support filtering operations found in the LoggingTool. For example, values for "Location", "Gender", "Strain", "Age Group" are subject attributes which are used to filter subjects but which are not actively maintained and edited by data curators.

Specified by:

getSubjectAttributeData in interface AdminServiceAPI

Returns:

Throws:

CSTException

databaseExists

public boolean databaseExists(User adminUser)
                       throws CSTException

Description copied from interface: AdminServiceAPI

determines whether the database described in the configuration file at startup exists or not.

Specified by:

databaseExists in interface AdminServiceAPI

Returns:

Throws:

CSTException

addUser

public void addUser(User adminUser,
                    User user)
             throws CSTException

Description copied from interface: AdminServiceAPI

add a user to the list of registered users of the system.

Specified by:

addUser in interface AdminServiceAPI

Throws:

CSTException

updateUser

public void updateUser(User adminUser,
                       User user)
                throws CSTException

Description copied from interface: AdminServiceAPI

update the details of an existing user

Specified by:

updateUser in interface AdminServiceAPI

Throws:

CSTException

deleteUser

public void deleteUser(User adminUser,
                       User user)
                throws CSTException

Description copied from interface: AdminServiceAPI

deletes a user from the registry of known users.

Specified by:

deleteUser in interface AdminServiceAPI

Throws:

CSTException

userExists

public boolean userExists(User adminUser,
                          java.lang.String userID)
                   throws CSTException

Description copied from interface: AdminServiceAPI

determines whether a given userID exists in the collection of registered users

Specified by:

userExists in interface AdminServiceAPI

Returns:

Throws:

CSTException

getRegisteredUsers

public java.util.ArrayList<User> getRegisteredUsers(User admin)
                                             throws CSTException

Description copied from interface: AdminServiceAPI

returns a collection of registered users for the system.

Specified by:

getRegisteredUsers in interface AdminServiceAPI

Returns:

Throws:

CSTException

getAdministratorID

public User getAdministratorID()

changeAdministratorPassword

public void changeAdministratorPassword(User candidateAdminUser,
                                        java.lang.String candidatePassword)
                                 throws CSTException

TODO - this method should probably be changed. I'm not sure how I want to implement Admin Password Changes, whether these methods should even be in the API.

Throws:

CSTException

importTrialSubjectModels

public void importTrialSubjectModels(User adminUser,
                                     java.util.ArrayList<TrialSubjectModel> trialSubjectModelsToImport)
                              throws CSTException

Description copied from interface: AdminServiceAPI

imports a collection of trial subject model records into the data repository. When a record is imported, an entry is made for both the subject attribute data and blank entries for each activity associated with it. Subject records each have a unique identifier. Imported subject records may overwrite existing records.

Specified by:

importTrialSubjectModels in interface AdminServiceAPI

Throws:

CSTException

getTrialSubjectModel

public TrialSubjectModel getTrialSubjectModel(User user,
                                              java.lang.String identifier)
                                       throws CSTException

Specified by:

getTrialSubjectModel in interface CSTServiceAPI

Throws:

CSTException

checkRepositoryIsSynchronised

public void checkRepositoryIsSynchronised(User adminUser)
                                   throws CSTException

Throws:

CSTException

synchroniseRepository

public void synchroniseRepository(User adminUser)
                           throws CSTException

Description copied from interface: AdminServiceAPI

ensures that every activity and activity step defined in the configuration file specied at startup has a corresponding entry in the data repository. Although this method is supported by both Demonstration and Production versions of the service, its main use is to ensure that elements in the configuration file match elements in the MySQL database.

Specified by:

synchroniseRepository in interface AdminServiceAPI

Throws:

CSTException

validateUser

public void validateUser(User user)
                  throws CSTException

Specified by:

validateUser in class AbstractDemonstrationService

Throws:

CSTException

validateAdministrator

public boolean validateAdministrator(User candidateAdminUser)
                              throws CSTException

Description copied from interface: AdminServiceAPI

determine whether a given user is the administrator or not

Specified by:

validateAdministrator in interface AdminServiceAPI

Returns:

Throws:

CSTException