Add HQ Users; (DOECODE-750)

Author: sowerstl

src/main/java/gov/osti/entity/Site.java

@@ -20,13 +20,19 @@
     @NamedQuery(name = "Site.findBySiteCode", query = "SELECT s FROM Site s WHERE s.siteCode = :site")
     ,
     @NamedQuery(name = "Site.findAll", query = "SELECT s FROM Site s ORDER BY s")
+    ,
+    @NamedQuery(name = "Site.findStandard", query = "SELECT s FROM Site s WHERE s.standardUsage = true ORDER BY s")
+    ,
+    @NamedQuery(name = "Site.findHQ", query = "SELECT s FROM Site s WHERE s.hqUsage = true ORDER BY s")
 })
 public class Site implements Serializable {
 
     private String siteCode;
     private List<String> emailDomains;
     private List<String> pocEmails;
     private String lab;
+    private boolean standardUsage = false;
+    private boolean hqUsage = false;
 
     public Site() {
     }
@@ -79,4 +85,22 @@ public String getLab() {
     public void setLab(String lab) {
         this.lab = lab;
     }
+
+    @Column(name = "standard_usage", nullable = false)
+    public boolean isStandardUsage() {
+        return standardUsage;
+    }
+
+    public void setStandardUsage(boolean usage) {
+        this.standardUsage = usage;
+    }
+
+    @Column(name = "hq_usage", nullable = false)
+    public boolean isHqUsage() {
+        return hqUsage;
+    }
+
+    public void setHqUsage(boolean usage) {
+        this.hqUsage = usage;
+    }
 }

src/main/java/gov/osti/entity/UserRole.java

@@ -24,7 +24,7 @@ public class UserRole implements Serializable {
      * Enumeration of valid Admin Roles for a Role.
      */
     public static enum RoleType {
-        ADMIN, STANDARD;
+        ADMIN, STANDARD, HQ;
     }
 
     private String value;
@@ -92,11 +92,12 @@ public static List<UserRole> GetRoles(RoleType roleType) {
             roles.add(new UserRole("ApprovalAdmin", "Approval Admin", "Permission to approve any project for biblio indexing."));
             roles.add(new UserRole("ContentAdmin", "Content Admin", "Permission to access content controls, such as Refresh, Reindex, etc."));
         }
-        else if (RoleType.STANDARD.equals(roleType)) {
+        else if (RoleType.STANDARD.equals(roleType) || RoleType.HQ.equals(roleType)) {
+            String namedQuery = "Site.find" + (RoleType.HQ.equals(roleType) ? "HQ" : "Standard");
             EntityManager em = DoeServletContextListener.createEntityManager();        
             try {
                 // get ALL SITES
-                TypedQuery<Site> query = em.createNamedQuery("Site.findAll", Site.class);
+                TypedQuery<Site> query = em.createNamedQuery(namedQuery, Site.class);
                 List<Site> siteList = query.getResultList();
 
                 for (Site site:siteList) {
@@ -121,11 +122,12 @@ public static List<String> GetRoleList(RoleType roleType) {
             roles.add("ApprovalAdmin");
             roles.add("ContentAdmin");
         }
-        else if (RoleType.STANDARD.equals(roleType)) {
+        else if (RoleType.STANDARD.equals(roleType) || RoleType.HQ.equals(roleType)) {
+            String namedQuery = "Site.find" + (RoleType.HQ.equals(roleType) ? "HQ" : "Standard");
             EntityManager em = DoeServletContextListener.createEntityManager();        
             try {
                 // get ALL SITES
-                TypedQuery<Site> query = em.createNamedQuery("Site.findAll", Site.class);
+                TypedQuery<Site> query = em.createNamedQuery(namedQuery, Site.class);
                 List<Site> siteList = query.getResultList();
 
                 for (Site site:siteList) {

src/main/java/gov/osti/services/SiteServices.md

@@ -61,7 +61,7 @@ Content-Length: 27
 Date: Mon, 14 Aug 2017 14:55:04 GMT
 ```
 ```json
-[{"site_code": "ABCD","email_domains": ["@abcd.gov"],"poc_emails": ["[email protected]","[email protected]"],"lab": "Alpha Bravo Charlie Delta"},{"site_code": "EFGH","email_domains": ["@efgh.gov"],"poc_emails": [],"lab": "Echo Foxtrot Golf Hotel"}]
+[{"site_code": "ABCD","email_domains": ["@abcd.gov"],"poc_emails": ["[email protected]","[email protected]"],"lab": "Alpha Bravo Charlie Delta","isStandardUsage":true,"isHqUsage":false},{"site_code": "EFGH","email_domains": ["@efgh.gov"],"poc_emails": [],"lab": "Echo Foxtrot Golf Hotel","isStandardUsage":true,"isHqUsage":false}]
 ```
 
 ### info/{site}

src/main/java/gov/osti/services/UserServices.java

@@ -468,14 +468,42 @@ public Response register(String object) {
 
             String encryptedPassword = PASSWORD_SERVICE.encryptPassword(request.getPassword());
 
-            // assign as SITE if possible based on the EMAIL, or default to CONTRACTOR
+            // assign a SITE if possible based on the EMAIL, or default to CONTRACTOR
             String domain = request.getEmail().substring(request.getEmail().indexOf("@"));
             TypedQuery<Site> query = em.createNamedQuery("Site.findByDomain", Site.class)
                     .setParameter("domain", domain);
 
             // look up the Site and set CODE, or CONTR if not found
             List<Site> sites = query.getResultList();
             String siteCode = ((sites.isEmpty()) ? "CONTR" : sites.get(0).getSiteCode());
+
+            if ("HQ".equals(siteCode)) {
+                String hqSiteId = request.getSiteId();
+                // ensure HQ registration provide a Site ID
+                if (StringUtils.isBlank(hqSiteId))
+                    return ErrorResponse
+                            .badRequest("Missing required Site ID for HQ registration.")
+                            .build();
+
+                // privided HQ Site Code must be valid.
+                query = em.createNamedQuery("Site.findBySiteCode", Site.class)
+                .setParameter("site", hqSiteId.trim());
+                sites = query.getResultList();
+
+                if (sites.isEmpty())
+                    return ErrorResponse
+                            .badRequest("HQ Site ID must be valid.")
+                            .build();
+
+                Site hqSite = sites.get(0);
+
+                if (!hqSite.isHqUsage())
+                    return ErrorResponse
+                            .badRequest("HQ Site ID must be designated as HQ type.")
+                            .build();
+
+                siteCode = hqSite.getSiteCode();
+            }
 
             // if CONTR, we need to REQUIRE and VALIDATE the CONTRACT NUMBER
             if (StringUtils.equals(siteCode, "CONTR")) {
@@ -1289,6 +1317,7 @@ private static class RegistrationRequest implements Serializable {
         private String password;
         private String confirmPassword;
         private String contractNumber;
+        private String siteId;
 
         public RegistrationRequest() {
 
@@ -1378,6 +1407,20 @@ public String getContractNumber() {
         public void setContractNumber(String contractNumber) {
             this.contractNumber = contractNumber;
         }
+
+        /**
+         * @return the HQ Site ID
+         */
+        public String getSiteId() {
+            return siteId;
+        }
+
+        /**
+         * @param siteId the HQ Site ID to set
+         */
+        public void setSiteId(String siteId) {
+            this.siteId = siteId;
+        }
 
     }
 
@@ -1511,19 +1554,27 @@ public Response confirmUser(@QueryParam("confirmation") String jwt) {
      * @return a Response containing the JSON if found
      */
     @GET
-    @RequiresAuthentication
-    @RequiresRoles("UserAdmin")
     @Produces (MediaType.APPLICATION_JSON)
     @Path ("/roles")
-    public Response getRoles() {       
+    public Response getRoles() { 
+        EntityManager em = DoeServletContextListener.createEntityManager();
+        Subject subject = SecurityUtils.getSubject();
+        User user = (User) subject.getPrincipal();
+
+        ObjectNode obj = mapper.createObjectNode();
+
+        // if UserAdmin, include admin roles.
+        if (user != null && user.hasRole("UserAdmin"))
+            obj.set("admin", mapper.valueToTree(UserRole.GetRoles(RoleType.ADMIN)));
+
+        obj.set("standard", mapper.valueToTree(UserRole.GetRoles(RoleType.STANDARD)));
+        obj.set("hq", mapper.valueToTree(UserRole.GetRoles(RoleType.HQ)));
+
         try {
             // return the results back
             return Response
                     .ok()
-                    .entity(((ObjectNode)mapper
-                            .createObjectNode()
-                            .set("admin", mapper.valueToTree(UserRole.GetRoles(RoleType.ADMIN))))
-                            .set("standard", mapper.valueToTree(UserRole.GetRoles(RoleType.STANDARD))).toString())
+                    .entity(obj.toString())
                     .build();
         } catch ( Exception e ) {
             log.error("Site Lookup Error", e);

src/main/java/gov/osti/services/UserServices.md

@@ -351,7 +351,7 @@ there is no upper limit.
 
 `GET /doecodeapi/services/user/roles`
 
-Returns JSON object containing "admin" and "standard".
+Returns JSON object containing "admin", "standard", and "hq" roles.
 Requires administrative access to veiw "admin" roles.
 Each role contains a value, label, and description.
 
@@ -368,7 +368,7 @@ HTTP/1.1 200 OK
 Content-Type: application/json
 ```
 ```json
-{"standard":[{"value":"OSTI","label":"OSTI","description":"Office of Scientific and Technical Information"}]}
+{"standard":[{"value":"OSTI","label":"OSTI","description":"Office of Scientific and Technical Information"}],"hq":[{"value":"DOESC","label":"DOESC","description":"USDOE Office of Science (SC)"}]}
 ```
 
 ### update (admin)