Changeset 1357

Timestamp:

Jan 10, 2011, 4:44:44 PM (13 years ago)

Author:

robert@…

Message:

Implemented module notification when a study changes (#259)

Location:

trunk

Files:

• grails-app/controllers/RestController.groovy (modified) (2 diffs)
• grails-app/domain/dbnp/studycapturing/AssayModule.groovy (modified) (1 diff)
• grails-app/domain/dbnp/studycapturing/Study.groovy (modified) (2 diffs)
• grails-app/services/dbnp/studycapturing/SynchronizationService.groovy (added)
• test/unit/gscf (added)
• test/unit/gscf/SynchronizationServiceTests.groovy (added)

trunk/grails-app/controllers/RestController.groovy

@@ -175 +175 @@
                         items[name] = value
                     }
+                                        
+                                        // Add study version number 
+                                        items['version'] = study.version;
+                                        
                     returnStudies.push items
                 }
@@ -183 +187 @@
         }
 
+        /**
+         * REST resource for data modules.
+         * Consumer and token should be supplied via URL parameters.
+         * Provides the version number of the specified study
+         *
+         * @param       studyToken  optional parameter. If no studyToken is given, a 400 error is given
+         * @param       consumer        consumer name of the calling module
+         * @param       token           token for the authenticated user (e.g. session_id)
+         * @return  JSON object list containing 'studyToken', and 'version'
+         *
+         * A 404 error might occur if the study doesn't exist, and a 401 error if the user is not
+         * authorized to access this study. 
+         *
+         * Example. REST call with one studyToken.
+         *
+         * Call: http://localhost:8080/gscf/rest/getStudyVersion?studyToken=PPSH
+         *
+         * Result: {"studyToken":"PPSH","version":31}
+         */
+        def getStudyVersion = {
+
+                def versionInfo = [:];
+                def study
+                
+                if( !params.studyToken || !(params.studyToken instanceof String)) {
+                        response.sendError(400)
+                        return false
+                } else {
+                        study = Study.findByCode( params.studyToken )
+                        if( study ) {
+                                if( !study.canRead(AuthenticationService.getRemotelyLoggedInUser( params.consumer, params.token )) ) {
+                                        response.sendError(401)
+                                        return false
+                                }
+                        } else {
+                                response.sendError(404)
+                                return false
+                        }
+                }
+
+                versionInfo[ 'studyToken' ] = params.studyToken;
+                versionInfo[ 'version' ] = study.version;
+
+                render versionInfo as JSON
+        }
 
         /**

trunk/grails-app/domain/dbnp/studycapturing/AssayModule.groovy

@@ -16 +16 @@
          */
         String url
+        
+        /** Determines whether this module will be notified of changes in studies. This can be used 
+         * to determine when synchronization should take place in a module. The URL called is
+         * 
+         * [url]/rest/notifyStudyChange?studyToken=abc
+         * 
+         * @see synchronizationService
+         */
+        boolean notify = false;
 
         static constraints = {

trunk/grails-app/domain/dbnp/studycapturing/Study.groovy

@@ -13 +13 @@
 class Study extends TemplateEntity {
         static searchable = true
+        
+        def synchronizationService
 
         SecUser owner           // The owner of the study. A new study is automatically owned by its creator.
@@ -499 +501 @@
                 }
         }
+
+        // Send messages to modules about changes in this study
+        def beforeInsert = {
+                synchronizationService.invalidateStudy( this );
+        }
+        def beforeUpdate = {
+                synchronizationService.invalidateStudy( this );
+        }
+        def beforeDelete = {
+                synchronizationService.invalidateStudy( this );
+        }
 }