Georgia Clinical and Translational Science Alliance (Georgia CTSA), Emory University, Atlanta, GA
It provides RESTful APIs for managing user agreements.
Add user template support. If turned on, when a user accesses any of this service's APIs, a user record with default privileges is created.
Fix 500 errors when the user has no record in the USERS table.
Mainly updates dependencies.
Mainly updates dependencies.
Provides REST APIs for users to sign a user agreement and check their most recent user agreement signature. It also provides APIs for admins to manage user agreements.
- Oracle Java JRE 8
- Tomcat 7
- One of the following relational databases:
- Oracle 11g or greater
- PostgreSQL 9.1 or greater
- H2 1.4.193 or greater (for testing)
Manages registering a user with this service for authorization purposes.
Call-dependent
Yes
Properties:
id
: unique number identifying the user (set by the server on object creation, and required thereafter).username
: required username string.roles
: array of numerical ids of roles.
All calls use standard names, return values and status codes as specified in the Eureka! Clinical microservice specification
Returns an array of all User objects. Requires the admin
role.
Returns a specified User object by the value of its id property, which is unique. Requires the admin
role to return any user record. Otherwise, it will only return the user's own record.
Returns a specified User object by its username, which is unique. Requires the admin
role to return any user record. Otherwise, it will only return the user's own record.
Returns the User object for the currently authenticated user.
Creates a new user. The User object is passed in as the body of the request. Returns the URI of the created User object. Requires the admin
role.
Updates the user object with the specified id. The User object is passed in as the body of the request. Requires the admin
role.
Manages roles for this service. It is read-only.
No.
Yes
Properties:
id
: unique number identifying the role.name
: the role's name string.
All calls use standard names, return values and status codes as specified in the Eureka! Clinical microservice specification
Returns an array of all User objects.
Returns a specified Role object by the value of its id property, which is unique.
Returns a specified Role object by its name, which is unique.
Manages user agreements. There is one active user agreement at a time, though the system maintains a history of older user agreements to link to what each user actually signed.
Call-dependent
Yes
Properties:
id
: unique number identifying the user (set by the server on object creation, and required thereafter).text
: the text of the user agreement, in Markdown format.effectiveAt
: a timestamp, in milliseconds since the epoch, indicating when this user agreement became current.expiredAt
: a timestamp, in milliseconds since the epoch, indicating when this user agreement was superceded by a newer one.
All calls use standard names, return values and status codes as specified in the Eureka! Clinical microservice specification
Returns an array of all UserAgreement objects. Requires the admin
role.
Returns a specified UserAgreement object by the value of its id property, which is unique.
Returns the currently active UserAgreement.
Creates a new user agreement. The UserAgreement object is passed in as the body of the request. Returns the URI of the created UserAgreement object. Requires the admin
role. If there is an existing user agreement, the old one will be expired, and this one will become effective.
Manages user agreement statuses, i.e., signatures. Each user has at most one user agreement status. If a user signs a user agreement and already has a user agreement status record, the old record will be replaced.
Call-dependent
Yes
Properties:
id
: unique number identifying the user agreement status record (set by the server on object creation, and required thereafter).username
: the username string of the signing user.fullname
: the full name that the user put in the signature field.expiry
: a timestamp, in milliseconds since the epoch, indicating when the agreement expires and the user has to sign another one.status
:ACTIVE
orEXPIRED
. Normally, it has the valueACTIVE
. Set toEXPIRED
to expire a user agreement prior to the expiry timestamp.userAgreement
: the unique numerical id of the user agreement that was presented to the user.
All calls use standard names, return values and status codes as specified in the Eureka! Clinical microservice specification
Returns an array of all UserAgreementStatus objects. Requires the admin
role.
Returns a specified UserAgreementStatus object by the value of its id property, which is unique. Will only return a UserAgreementStatus object if it was signed by the current user.
Returns the current user's active UserAgreementStatus, if there is one. If the status
query parameter is used, it will only get a UserAgreementStatus for the user if one exists and it has the specified status value.
Creates a new user agreement status for the current user. The UserAgreementStatus object is passed in as the body of the request. Returns the URI of the created UserAgreementStatus object.
The project uses the maven build tool. Typically, you build it by invoking mvn clean install
at the command line. For simple file changes, not additions or deletions, you can usually use mvn install
. See https://github.com/eurekaclinical/dev-wiki/wiki/Building-Eureka!-Clinical-projects for more details.
You can run this project in an embedded tomcat by executing mvn process-resources cargo:run -Ptomcat
after you have built it. It will be accessible in your web browser at https://localhost:8443/eurekaclinical-user-agreement-service/. Your username will be superuser
.
A Liquibase changelog is provided in src/main/resources/dbmigration/
for creating the schema and objects. Liquibase 3.3 or greater is required.
Perform the following steps:
- Create a schema in your database and a user account for accessing that schema.
- Get a JDBC driver for your database and put it the liquibase lib directory.
- Run the following:
./liquibase \
--driver=JDBC_DRIVER_CLASS_NAME \
--classpath=/path/to/jdbcdriver.jar:/path/to/eurekaclinical-user-agreement-service.war \
--changeLogFile=dbmigration/changelog-master.xml \
--url="JDBC_CONNECTION_URL" \
--username=DB_USER \
--password=DB_PASS \
update
- Add the following Resource tag to Tomcat's
context.xml
file:
<Context>
...
<Resource name="jdbc/EurekaClinicalUserAgreementService" auth="Container"
type="javax.sql.DataSource"
driverClassName="JDBC_DRIVER_CLASS_NAME"
factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
url="JDBC_CONNECTION_URL"
username="DB_USER" password="DB_PASS"
initialSize="3" maxActive="20" maxIdle="3" minIdle="1"
maxWait="-1" validationQuery="SELECT 1" testOnBorrow="true"/>
...
</Context>
The validation query above is suitable for PostgreSQL. For Oracle and H2, use
SELECT 1 FROM DUAL
.
This service is configured using a properties file located at /etc/ec-user-agreement/application.properties
. It supports the following properties:
eurekaclinical.useragreementservice.callbackserver
: https://hostname:porteurekaclinical.useragreementservice.url
: https://hostname:port/eurekaclinical-user-agreement-servicecas.url
: https://hostname.of.casserver:port/cas-server
A Tomcat restart is required to detect any changes to the configuration file.
- Stop Tomcat.
- Remove any old copies of the unpacked war from Tomcat's webapps directory.
- Copy the warfile into the tomcat webapps directory, renaming it to remove the version. For example, rename
eurekaclinical-user-agreement-webapp-1.0.war
toeurekaclinical-user-agreement-webapp.war
. - Start Tomcat.
<dependency>
<groupId>org.eurekaclinical</groupId>
<artifactId>eurekaclinical-user-agreement-service</artifactId>
<version>version</version>
</dependency>
Feel free to contact us at help@eurekaclinical.org.