Updating session timeout with signinurl and textoverrides - v2 (#74)

* Updating session timeout with signinurl and textoverrides

* Updating changelog

Author: ahmad-shahid

CHANGELOG.md

@@ -5,6 +5,8 @@
 ## v2.7.4
 
 - [CDTS](https://github.com/wet-boew/cdts-sgdc/) v5.0.4 & [wet-boew](https://github.com/wet-boew/wet-boew) v4.0.85
+- Adding an optional signInUrl property for Session Timeout allowing users to specify the sign-in page url when the session has expired
+- Adding an optional textOverrides property for Session Timeout allowing users to override specific text elements
 - Updated static fallback files
 
 ## v2.7.3

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/SessionTimeout.java

@@ -15,6 +15,8 @@ public class SessionTimeout implements Serializable {
 	private int refreshLimit = 0;
 	private String method = "";
 	private String additionalData = "";
+	private String signInUrl = "";
+	private SessionTimeoutTextOverrides textOverrides = null;
 
     public SessionTimeout() {
     }
@@ -31,10 +33,24 @@ public SessionTimeout(int inactivity, int reactiontime, int sessionalive,
              method, additionaldata);
     }
 
+    public SessionTimeout(boolean enabled, int inactivity, int reactiontime, int sessionalive,
+            String logouturl, String refreshcallbackurl,
+            boolean refreshonclick, int refreshlimit,
+            String method, String additionaldata) {
+
+        this(false,
+                inactivity, reactiontime, sessionalive,
+                logouturl, refreshcallbackurl,
+                refreshonclick, refreshlimit,
+                method, additionaldata,
+                "", null);
+    }
+
     public SessionTimeout(boolean enabled, int inactivity, int reactiontime, int sessionalive, 
             String logouturl, String refreshcallbackurl, 
             boolean refreshonclick, int refreshlimit, 
-            String method, String additionaldata) {
+            String method, String additionaldata,
+            String signinurl, SessionTimeoutTextOverrides textoverrides) {
 
         this.enabled = enabled;
         this.inactivity = inactivity;
@@ -46,6 +62,8 @@ public SessionTimeout(boolean enabled, int inactivity, int reactiontime, int ses
         this.refreshLimit = refreshlimit;
         this.method = method;
         this.additionalData = additionaldata;
+        this.signInUrl = signinurl;
+        this.textOverrides = textoverrides;
     }
 
     public boolean isEnabled() {
@@ -127,4 +145,20 @@ public String getAdditionalData() {
 	public void setAdditionalData(String additionalData) {
 		this.additionalData = additionalData;
 	}
+
+	public String getSignInUrl() {
+		return signInUrl;
+	}
+
+	public void setSignInUrl(String signInUrl) {
+		this.signInUrl = signInUrl;
+	}
+
+	public SessionTimeoutTextOverrides getTextOverrides() {
+		return textOverrides;
+	}
+
+	public void setTextOverrides(SessionTimeoutTextOverrides textOverrides) {
+		this.textOverrides = textOverrides;
+	}
 }

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/SessionTimeoutTextOverrides.java

@@ -0,0 +1,71 @@
+package goc.webtemplate;
+
+/**
+ * Optional button text and message elements to override the defaults in SessionTimeout
+*/
+public class SessionTimeoutTextOverrides {
+    private String buttonContinue;
+    private String buttonEnd;
+    private String buttonSignIn;
+    private String timeoutEnd;
+    private String timeoutAlready;
+
+    public SessionTimeoutTextOverrides() {}
+
+    /**
+     * Create new SessionTimeoutTextOverrides
+     * @param buttonContinue Text for the Continue Session button
+     * @param buttonEnd Text for the End Session button
+     * @param buttonSignIn Text for the Sign In button
+     * @param timeoutEnd Text for the message displayed below the timer
+     * @param timeoutAlready Text for the message displayed when the session has expired
+    */
+    public SessionTimeoutTextOverrides(String buttonContinue, String buttonEnd, String buttonSignIn, String timeoutEnd, String timeoutAlready)
+    {
+        this.buttonContinue = buttonContinue;
+        this.buttonEnd = buttonEnd;
+        this.buttonSignIn = buttonSignIn;
+        this.timeoutEnd = timeoutEnd;
+        this.timeoutAlready = timeoutAlready;
+    }
+
+    public String getButtonContinue() {
+        return buttonContinue;
+    }
+
+    public void setButtonContinue(String buttonContinue) {
+        this.buttonContinue = buttonContinue;
+    }
+
+    public String getButtonEnd() {
+        return buttonEnd;
+    }
+
+    public void setButtonEnd(String buttonEnd) {
+        this.buttonEnd = buttonEnd;
+    }
+
+    public String getButtonSignIn() {
+        return buttonSignIn;
+    }
+
+    public void setButtonSignIn(String buttonSignIn) {
+        this.buttonSignIn = buttonSignIn;
+    }
+
+    public String getTimeoutEnd() {
+        return timeoutEnd;
+    }
+
+    public void setTimeoutEnd(String timeoutEnd) {
+        this.timeoutEnd = timeoutEnd;
+    }
+
+    public String getTimeoutAlready() {
+        return timeoutAlready;
+    }
+
+    public void setTimeoutAlready(String timeoutAlready) {
+        this.timeoutAlready = timeoutAlready;
+    }
+}

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java

@@ -1654,6 +1654,9 @@ private SessionTimeout buildDefaultSessionTimeoutConfigurations(java.util.Resour
 
             if (!Utility.isNullOrEmpty(bundle.getString("session.additionaldata"))) 
                 configs.setAdditionalData(bundle.getString("session.additionaldata"));
+
+            if (!Utility.isNullOrEmpty(bundle.getString("session.signinurl")))
+                configs.setSignInUrl(bundle.getString("session.signinurl"));
         }
 
         return configs;

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/SessionTimeout.java

@@ -2,6 +2,7 @@
 
 import java.io.Serializable;
 
+import goc.webtemplate.SessionTimeoutTextOverrides;
 import goc.webtemplate.component.JsonValueUtils;
 
 /**
@@ -25,6 +26,8 @@ public class SessionTimeout implements Serializable {
     private Integer refreshLimit = null;
     private String method = null;
     private String additionalData = null;
+    private String signInUrl = null;
+    private SessionTimeoutTextOverrides textOverrides = null;
 
     public SessionTimeout() {
     }
@@ -44,11 +47,14 @@ public SessionTimeout(goc.webtemplate.SessionTimeout otherObj) {
         this.refreshLimit = otherObj.getRefreshLimit() > 0? otherObj.getRefreshLimit(): null;
         this.method = JsonValueUtils.getNonEmptyString(otherObj.getMethod());
         this.additionalData = JsonValueUtils.getNonEmptyString(otherObj.getAdditionalData());
+        this.signInUrl = JsonValueUtils.getNonEmptyString(otherObj.getSignInUrl());
+        this.textOverrides = otherObj.getTextOverrides();
     }
 
     public SessionTimeout(Integer inactivity, Integer reactionTime, Integer sessionalive,
                           String logouturl, String refreshCallbackUrl, Boolean refreshOnClick,
-                          Integer refreshLimit, String method, String additionalData) {
+                          Integer refreshLimit, String method, String additionalData,
+                          String signInUrl, SessionTimeoutTextOverrides textOverrides) {
         this.inactivity = inactivity;
         this.reactionTime = reactionTime;
         this.sessionalive = sessionalive;
@@ -58,6 +64,8 @@ public SessionTimeout(Integer inactivity, Integer reactionTime, Integer sessiona
         this.refreshLimit = refreshLimit;
         this.method = method;
         this.additionalData = additionalData;
+        this.signInUrl = signInUrl;
+        this.textOverrides = textOverrides;
     }
 
     public Integer getInactivity() {
@@ -132,4 +140,20 @@ public void setAdditionalData(String additionalData) {
         this.additionalData = additionalData;
     }
 
+    public String getSignInUrl() {
+        return signInUrl;
+    }
+
+    public void setSignInUrl(String signInUrl) {
+        this.signInUrl = signInUrl;
+    }
+
+    public SessionTimeoutTextOverrides getTextOverrides() {
+        return textOverrides;
+    }
+
+    public void setTextOverrides(SessionTimeoutTextOverrides textOverrides) {
+        this.textOverrides = textOverrides;
+    }
+
 }

gocwebtemplate-core/gocwebtemplate-core-jsp/src/test/resources/goc/webtemplate/global/config/cdn.properties

@@ -44,6 +44,7 @@ session.refreshonclick=
 session.refreshlimit.value=120000
 session.method=
 session.additionaldata=
+session.signinurl=
 #
 # GoC Web Template Global Config Values
 goc.webtemplate.showlanguagelink=true

gocwebtemplate-sample-jsp/src/main/java/goc/webtemplate/jsp/samplebeans/SessionTimeoutSampleBean.java

@@ -9,7 +9,7 @@
 
 import goc.webtemplate.Breadcrumb;
 import goc.webtemplate.SessionTimeout;
-
+import goc.webtemplate.SessionTimeoutTextOverrides;
 import goc.webtemplate.component.jsp.DefaultTemplateCoreBean;
 
 public class SessionTimeoutSampleBean extends DefaultTemplateCoreBean {
@@ -26,6 +26,8 @@ public void onWebTemplateInitialize() {
         this.setBreadcrumbs(bcs);
 
         SessionTimeout sconfig = new SessionTimeout();
+        SessionTimeoutTextOverrides textOverrides = new SessionTimeoutTextOverrides();
+        textOverrides.setButtonContinue("Keep Going");
 
         sconfig.setEnabled(true);
         sconfig.setInactivity(30000);
@@ -37,6 +39,8 @@ public void onWebTemplateInitialize() {
         sconfig.setRefreshLimit(3);
         sconfig.setMethod("");
         sconfig.setAdditionalData("");
+        sconfig.setSignInUrl("");
+        sconfig.setTextOverrides(textOverrides);
 
         this.setSessionTimeoutConfiguration(sconfig);
     }

gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/sessiontimeoutsamplecontent.jsp

@@ -31,6 +31,15 @@
     <li><strong>session.refreshlimit.value</strong>: Sets the amount of time that must pass before an ajax request can be made</li>
     <li><strong>session.method</strong>: Sets the request method used for ajax requests. Recommended: GET or POST</li>
     <li><strong>session.additionaldata</strong>: Additional data to send with the request</li>
+    <li><strong>session.signinurl</strong>: URL to the Sign-In page</li>
+</ul>
+<p>Override the default text and message elements programmatically via the <code class="wb-prettify">setTextOverrides</code> method using the SessionTimeoutTextOverrides object: </p>
+<ul>
+    <li><strong>buttonContinue</strong>: Text for the Continue Session button</li>
+    <li><strong>buttonEnd</strong>: Text for the End Session button</li>
+    <li><strong>buttonSignin</strong>: Text for the Sign In button</li>
+    <li><strong>timeoutEnd</strong>: Text for the message displayed below the timer</li>
+    <li><strong>timeoutAlready</strong>: Text for the message displayed when the session has expired</li>
 </ul>
 <h4>Notes:</h4>
 <ul>

gocwebtemplate-sample-spring/src/main/java/goc/webtemplate/spring/samplebeans/SessionTimeoutSampleBean.java

@@ -11,6 +11,7 @@
 
 import goc.webtemplate.Breadcrumb;
 import goc.webtemplate.SessionTimeout;
+import goc.webtemplate.SessionTimeoutTextOverrides;
 import goc.webtemplate.component.spring.DefaultTemplateCoreBean;
 
 @Component(value = "sessiontimeoutsamplebean")
@@ -28,6 +29,8 @@ public void onWebTemplateInitialize() {
         this.setBreadcrumbs(bcs);
 
         SessionTimeout sconfig = new SessionTimeout();
+        SessionTimeoutTextOverrides textOverrides = new SessionTimeoutTextOverrides();
+        textOverrides.setButtonContinue("Keep Going");
 
         sconfig.setEnabled(true);
         sconfig.setInactivity(30000);
@@ -39,6 +42,8 @@ public void onWebTemplateInitialize() {
         sconfig.setRefreshLimit(3);
         sconfig.setMethod("");
         sconfig.setAdditionalData("");
+        sconfig.setSignInUrl("");
+        sconfig.setTextOverrides(textOverrides);
 
         this.setSessionTimeoutConfiguration(sconfig);
     }

gocwebtemplate-sample-spring/src/main/resources/goc/webtemplate/global/config/cdn.properties

@@ -44,6 +44,7 @@ session.refreshonclick=
 session.refreshlimit.value=120000
 session.method=
 session.additionaldata=
+session.signinurl=
 #
 # GoC Web Template Global Config Values
 goc.webtemplate.showlanguagelink=true