Issue 1649

src/main/java/com/parallax/server/blocklyprop/SessionData.java

@@ -1,8 +1,24 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop;
 
 import com.google.inject.servlet.SessionScoped;
@@ -13,15 +29,21 @@
  * User session details.
  * 
  * This class contains the fields used to manage the client's session with
- * the application.
+ * the application. The @SessionScoped decorator will enforce a single
+ * instance per session.
  * 
  * @author Michel
  */
 @SessionScoped
 public class SessionData implements Serializable {
 
+    // A cloud session user profile object
     private User user;
+
+    // A cloud session user profile primary key ID
     private Long idUser;
+
+    // A locale string for this user
     private String locale;
 
     /**
@@ -54,6 +76,11 @@ public void setLocale(String locale) {
         this.locale = locale;
     }
 
+    /**
+     *  Override the default toString method to enumerate all fields
+     *
+     * @return string representation of SessionData fields
+     */
     @Override
     public String toString() {
         return "SessionData{" + "user=" + user + ", idUser=" + idUser + ", locale=" + locale + '}';

src/main/java/com/parallax/server/blocklyprop/TableOrder.java

@@ -1,17 +1,32 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop;
 
 /**
+ * Enumberate possible sort orders for project listings
  *
  * @author Michel
  */
 public enum TableOrder {
-
     asc,
     desc
-
 }

src/main/java/com/parallax/server/blocklyprop/TableSort.java

@@ -1,15 +1,32 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop;
 
 import com.parallax.server.blocklyprop.db.generated.Tables;
 import com.parallax.server.blocklyprop.db.generated.tables.records.ProjectRecord;
 import org.jooq.TableField;
 
 /**
+ * A list of the possible fields on which to sort project data
  *
  * @author Michel
  */
@@ -21,14 +38,14 @@ public enum TableSort {
     user(Tables.PROJECT.ID_USER),
     modified(Tables.PROJECT.MODIFIED);
 
+    // Map this enum to a Field in the JooQ ProjectRecord class
     private final TableField<ProjectRecord, ?> field;
 
-    private TableSort(TableField<ProjectRecord, ?> field) {
+    TableSort(TableField<ProjectRecord, ?> field) {
         this.field = field;
     }
 
     public TableField<ProjectRecord, ?> getField() {
         return field;
     }
-
 }

src/main/java/com/parallax/server/blocklyprop/config/SetupConfig.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Parallax Inc.
+ * Copyright (c) 2019 Parallax Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
  * and associated documentation files (the “Software”), to deal in the Software without
@@ -64,6 +64,7 @@ protected Injector getInjector() {
 
             @Override
             protected void configure() {
+
                 bind(Configuration.class).toInstance(configuration);
 
                 bind(SessionData.class);

src/main/java/com/parallax/server/blocklyprop/converter/UserConverter.java

@@ -10,6 +10,7 @@
 import com.parallax.server.blocklyprop.db.generated.tables.records.UserRecord;
 
 /**
+ * Convert user object to a Json string
  *
  * @author Michel
  */

src/main/java/com/parallax/server/blocklyprop/db/dao/UserDao.java

@@ -18,9 +18,24 @@ public interface UserDao {
 
     @Deprecated
     UserRecord create(Long idCloudSession);
-
+
+    /**
+     * Update the blockly user screen name
+     *
+     * @param idUser - is the long integer id for the blockly user record
+     * @param screenName - is ghe new screen name to store in the user record
+     */
+    void updateScreenName(Long idUser, String screenName);
+
+    /**
+     *
+     * @param idCloudSession
+     * @param screenName
+     * @return
+     */
     UserRecord create(Long idCloudSession, String screenName);
 
+
     /**
      * Retrieve a BP user record
      * 
@@ -38,16 +53,34 @@ public interface UserDao {
      */
     UserRecord getUser(Long idCloudSession, String screenName);
 
-
+    /**
+     *
+      * @return
+     */
     List<UserRecord> getAll();
 
+    /**
+     *
+     * @param idUser
+     * @param roles
+     */
     void setRoles(Long idUser, Set<Role> roles);
 
+    /**
+     *
+     * @param idUser
+     * @return
+     */
     List<Role> getRoles(Long idUser);
 
-    Long getUserIdForCloudSessionUserId(Long id);
-
-    @Deprecated
-    public void updateScreenname(Long idUser, String screenname);
-
+    /**
+     * Obtain the blocklyprop user ID from the supplied cloud session user id
+     *
+     * @param idCloudSession
+     * The user profile ID
+     *
+     * @return
+     * Returns a Long integer blocklyprop user ID if successful, otherwise returns zero
+     */
+    Long getUserIdForCloudSessionUserId(Long idCloudSession);
 }

src/main/java/com/parallax/server/blocklyprop/db/dao/impl/SessionDaoImpl.java

@@ -1,8 +1,24 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop.db.dao.impl;
 
 import com.google.inject.Inject;
@@ -62,7 +78,8 @@ public void setConfiguration(Configuration configuration) {
      */
     @Override
     public void create(SessionRecord session) {
-        LOG.info("Create a session. Timeout set to: {}", session.getTimeout());
+
+        LOG.debug("Create a session. Timeout set to: {}", session.getTimeout());
 
         // Log session details if the configuration file permits it
         printSessionInfo("create", session);
@@ -98,7 +115,9 @@ public void create(SessionRecord session) {
      */
     @Override
     public SessionRecord readSession(String idSession) throws NullPointerException {
-        LOG.debug("Getting session details");
+
+        LOG.debug("Getting session {} details", idSession);
+
         SessionRecord sessionRecord = null;
 
         try {
@@ -112,9 +131,8 @@ public SessionRecord readSession(String idSession) throws NullPointerException {
         catch (org.jooq.exception.DataAccessException sqex) {
             LOG.error("Database exception {}", sqex.getMessage());
         }
-        finally {
-            return sessionRecord;
-        }
+
+        return sessionRecord;
    }
 
     /**
@@ -124,6 +142,7 @@ public SessionRecord readSession(String idSession) throws NullPointerException {
      */
     @Override
     public void updateSession(SessionRecord session) throws NullPointerException {
+
         LOG.debug("Update a session");
 
         try {
@@ -158,8 +177,12 @@ public void updateSession(SessionRecord session) throws NullPointerException {
      */
     @Override
     public void deleteSession(String idSession) {
+
         LOG.info("Deleting session {}", idSession);
-        create.deleteFrom(Tables.SESSION).where(Tables.SESSION.IDSESSION.eq(idSession)).execute();
+
+        create.deleteFrom(Tables.SESSION)
+                .where(Tables.SESSION.IDSESSION.eq(idSession))
+                .execute();
     }
 
     /**