diff --git a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/entity/User.java b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/entity/User.java index ee73cea40..20664afe7 100644 --- a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/entity/User.java +++ b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/entity/User.java @@ -75,6 +75,9 @@ public User(User user) { @Column(name = "long_term_token") private String token; + /** + * This is a passport for the user represented as a string. See the Passport class for more information. + */ @Column(name = "passport") private String passport; diff --git a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghPassportV1.java b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghPassportV1.java index 924bc3b5c..33667652b 100644 --- a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghPassportV1.java +++ b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghPassportV1.java @@ -4,6 +4,17 @@ import java.util.List; +/** + * The Ga4ghPassportV1 class is a model for the GA4GH Passport V1 object. + * passport-claim + * + *

+ * Description + *
+ * The GA4GH Passport V1 object is a JSON Web Token (JWT) that contains information about a user's identity, the signing entity (ga4ghVisaV1), and + * the permissions they have been granted (RasDbgapPermissions). + *

+ */ public class Ga4ghPassportV1 { private String iss; diff --git a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghVisaV1.java b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghVisaV1.java index e6531a6f8..1bb6534c8 100644 --- a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghVisaV1.java +++ b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Ga4ghVisaV1.java @@ -1,5 +1,9 @@ package edu.harvard.hms.dbmi.avillach.auth.model.ras; +/** + * The Ga4ghVisaV1 class is a model for the GA4GH Visa V1 object. + * ga4gh_passport_v1.md#visa-claim + */ public class Ga4ghVisaV1 { private String type; diff --git a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Passport.java b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Passport.java index 8b746f80a..5f31963db 100644 --- a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Passport.java +++ b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/Passport.java @@ -4,6 +4,10 @@ import java.util.List; +/** + * The RAS Passport JWT as defined by RAS in their developer documentation. + * Contains a list of claims about the user and the user's identity and a list of GA4Gh Passports as defined in the GA4GH standard. + */ public class Passport { private String sub; diff --git a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/RasDbgapPermission.java b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/RasDbgapPermission.java index b5a9d4dcd..25f3d233a 100644 --- a/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/RasDbgapPermission.java +++ b/pic-sure-auth-services/src/main/java/edu/harvard/hms/dbmi/avillach/auth/model/ras/RasDbgapPermission.java @@ -2,6 +2,21 @@ import com.fasterxml.jackson.annotation.JsonProperty; +/** + * The RasDbgapPermission class is a model for the RAS dbGaP Permission object. An example of this object is: + * This is not a real study, but an example of what the object looks like. + *
+ *     {
+ *       "consent_name": "Unrestricted",
+ *       "phs_id": "phs000123",
+ *       "version": "v1",
+ *       "participant_set": "p1",
+ *       "consent_group": "c1",
+ *       "role": "pi",
+ *       "expiration": 1234567890
+ *     }
+ * 
+ */ public class RasDbgapPermission { @JsonProperty("consent_name")