added base api classes

src/java/DmWebPortal/src/java/gov/anl/aps/dm/api/DmSession.java

+package gov.anl.aps.dm.api;
+
+import gov.anl.aps.dm.common.constants.DmRole;
+import gov.anl.aps.dm.common.exceptions.InvalidSession;
+import java.io.Serializable;
+import java.net.HttpCookie;
+
+/**
+ * DM session class, used for keeping all session-related information (session
+ * id, username, role, etc.).
+ */
+public class DmSession implements Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    private String id = null;
+    private String username = null;
+    private String cookie = null;
+    private DmRole role = null;
+
+    public DmSession() {
+    }
+
+    public String getUsername() {
+        return username;
+    }
+
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getCookie() {
+        return cookie;
+    }
+
+    public void setCookie(String cookie) {
+        this.cookie = cookie;
+    }
+
+    public String verifyCookie() throws InvalidSession {
+        if (cookie == null) {
+            throw new InvalidSession("Valid session has not been established.");
+        } else {
+            HttpCookie httpCookie = HttpCookie.parse(cookie).get(0);
+            if (httpCookie.hasExpired()) {
+                throw new InvalidSession("Session id " + id + " has expired.");
+            }
+        }
+        return cookie;
+    }
+
+    public DmRole getRole() {
+        return role;
+    }
+
+    public void setRole(DmRole role) {
+        this.role = role;
+    }
+
+    public boolean isAdminRole() {
+        if (role != null) {
+            return role.equals(DmRole.ADMIN);
+        }
+        return false;
+    }
+
+    public boolean isUserRole() {
+        if (role != null) {
+            return role.equals(DmRole.USER);
+        }
+        return false;
+    }
+
+    @Override
+    public String toString() {
+        String result = "{ ";
+        String delimiter = "";
+        if (username != null) {
+            result += "username :" + username;
+            delimiter = "; ";
+        }
+        if (id != null) {
+            result += delimiter + "id : " + id;
+            delimiter = "; ";
+        }
+        if (cookie != null) {
+            result += delimiter + "cookie : " + cookie;
+        }
+        result += " }";
+        return result;
+    }
+}