Making changes to support new footer

ahmad-shahid · ahmad-shahid · commit 2b465f87dc0f · 2023-02-02T13:33:26.000-05:00
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/BannerLink.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/BannerLink.java
@@ -0,0 +1,50 @@
+package goc.webtemplate;
+
+public class BannerLink {
+    private String href;
+    private String text;
+    private boolean newWindow;
+    
+    public BannerLink() {}
+
+    public BannerLink(String href)
+    {
+        this(href, "");
+    }
+
+    public BannerLink(String href, String text)
+    {   
+        this(href, text, false);
+    }
+
+    public BannerLink(String href, String text, boolean newWindow)
+    {   
+        this.href = href;
+        this.text = text;
+        this.newWindow = newWindow;
+    }
+
+    public String getHref() {
+        return href;
+    }
+
+    public void setHref(String href) {
+        this.href = href;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+
+    public boolean isNewWindow() {
+        return newWindow;
+    }
+
+    public void setNewWindow(boolean newWindow) {
+        this.newWindow = newWindow;
+    }
+}
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/ContextualFooter.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/ContextualFooter.java
@@ -5,11 +5,11 @@
 public class ContextualFooter {
 
     private String title;
-    private List<Link> links;
+    private List<FooterLink> links;
 
     public ContextualFooter() {}
 
-    public ContextualFooter(String title, List<Link> links)
+    public ContextualFooter(String title, List<FooterLink> links)
     {
         this.title = title;
         this.links = links;
@@ -23,11 +23,11 @@ public void setTitle(String title) {
         this.title = title;
     }
 
-    public List<Link> getLinks() {
+    public List<FooterLink> getLinks() {
         return links;
     }
 
-    public void setLinks(List<Link> links) {
+    public void setLinks(List<FooterLink> links) {
         this.links = links;
     }
 }
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/InfoBanner.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/InfoBanner.java
@@ -2,12 +2,12 @@
 
 public class InfoBanner {
     private String mainHTML;
-    private Link link;
-    private Link button;
+    private BannerLink link;
+    private BannerLink button;
 
     public InfoBanner() {}
 
-    public InfoBanner(String mainHTML, Link link, Link button)
+    public InfoBanner(String mainHTML, BannerLink link, BannerLink button)
     {
         this.mainHTML = mainHTML;
         this.link = link;
@@ -22,19 +22,19 @@ public void setMainHTML(String mainHTML) {
         this.mainHTML = mainHTML;
     }
 
-    public Link getLink() {
+    public BannerLink getLink() {
         return link;
     }
 
-    public void setLink(Link link) {
+    public void setLink(BannerLink link) {
         this.link = link;
     }
 
-    public Link getButton() {
+    public BannerLink getButton() {
         return button;
     }
 
-    public void setButton(Link button) {
+    public void setButton(BannerLink button) {
         this.button = button;
     }
 }
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/Link.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/Link.java
@@ -6,7 +6,6 @@
 public class Link implements Serializable, Cloneable {
     private String href = "";
     private String text = "";
-    private boolean newWindow;
     
     public Link() {}
 
@@ -16,15 +15,9 @@ public Link(String href)
     }
     
     public Link(String href, String text)
-    {
-        this(href, text, false);
-    }
-
-    public Link(String href, String text, boolean newWindow)
     {   
         this.href = href;
         this.text = text;
-        this.newWindow = newWindow;
     }
 
     public void setHref(String href) { this.href = href; }
@@ -33,9 +26,6 @@ public Link(String href, String text, boolean newWindow)
     public void setText(String text) { this.text = text; }
     public String getText() { return this.text; }
     
-    public void setNewWindow(boolean value) { this.newWindow = value; }
-    public boolean getNewWindow() {return this.newWindow; }
-
     public Link clone() {
     	try {
     		return (Link)super.clone();
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java
@@ -33,6 +33,8 @@
 import goc.webtemplate.Utility;
 import goc.webtemplate.WebAnalyticsInfo;
 
+import static goc.webtemplate.component.JsonRenderer.gson;
+
 import goc.webtemplate.component.jsonentities.AppFooter;
 import goc.webtemplate.component.jsonentities.AppTop;
 import goc.webtemplate.component.jsonentities.CDTSEnvironment;
@@ -61,19 +63,6 @@
  *
  */
 public abstract class AbstractCoreBean {
-    /**
-     * Object used for JSON serialization.  (https://github.com/google/gson)
-     * 
-     * According to documentation (http://www.javadoc.io/doc/com.google.code.gson/gson/2.8.0) 
-     * and source code, Gson objects are thread-safe.
-     */
-    //NOTE: Doesn't render null values by default, which is what we want
-    //NOTE: Escapes HTML by default, which is what we want (though URLs still need to be encoded)
-    //NOTE: Indented output can be obtained by chaining a call to setPrettyPrinting()
-    private static Gson gson = new com.google.gson.GsonBuilder()
-                                        .setFieldNamingPolicy(com.google.gson.FieldNamingPolicy.IDENTITY)
-                                        .create();
-
     /**
      * Hold the table of CDTS environment configuration objects (loaded the first time it is accessed).
      */
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/JsonRenderer.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/JsonRenderer.java
@@ -0,0 +1,18 @@
+package goc.webtemplate.component;
+
+import com.google.gson.Gson;
+
+public final class JsonRenderer {
+    /**
+     * Object used for JSON serialization.  (https://github.com/google/gson)
+     * 
+     * According to documentation (http://www.javadoc.io/doc/com.google.code.gson/gson/2.8.0) 
+     * and source code, Gson objects are thread-safe.
+     */
+    //NOTE: Doesn't render null values by default, which is what we want
+    //NOTE: Escapes HTML by default, which is what we want (though URLs still need to be encoded)
+    //NOTE: Indented output can be obtained by chaining a call to setPrettyPrinting()
+    public static Gson gson = new com.google.gson.GsonBuilder()
+                                        .setFieldNamingPolicy(com.google.gson.FieldNamingPolicy.IDENTITY)
+                                        .create();
+}
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/JsonValueUtils.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/JsonValueUtils.java
@@ -5,10 +5,11 @@
 import java.util.List;
 
 import goc.webtemplate.FooterLink;
-import goc.webtemplate.FooterLinkContext;
 import goc.webtemplate.Link;
 import goc.webtemplate.Utility;
 
+import goc.webtemplate.component.jsonentities.FooterLinkContext;
+
 public final class JsonValueUtils {
     
     /**
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/Footer.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/Footer.java
@@ -8,7 +8,6 @@
 
 import goc.webtemplate.ContextualFooter;
 import goc.webtemplate.FooterLink;
-import goc.webtemplate.FooterLinkContext;
 import goc.webtemplate.Link;
 
 /**
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/FooterLinkContext.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/FooterLinkContext.java
@@ -1,4 +1,6 @@
-package goc.webtemplate;
+package goc.webtemplate.component.jsonentities;
+
+import goc.webtemplate.FooterLink;
 
 public class FooterLinkContext {
 
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/adapters/FooterLinkAdapter.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/adapters/FooterLinkAdapter.java
@@ -5,7 +5,9 @@
 import com.google.gson.stream.JsonReader;
 import com.google.gson.stream.JsonWriter;
 
-import goc.webtemplate.FooterLinkContext;
+import static goc.webtemplate.component.JsonRenderer.gson;
+
+import goc.webtemplate.component.jsonentities.FooterLinkContext;
 
 /**
  * GSON type adapter for serializing the "privacyLink" or "termsLink" parameter to the WET
@@ -23,18 +25,12 @@ public void write(JsonWriter jw, FooterLinkContext obj) throws IOException {
 
         //If showFooter is false, render footer link as an array
         if (!obj.isShowFooter()) jw.beginArray();
-        jw.beginObject();
-        jw.name("href");
-        jw.value(obj.getFooterLink().getHref());
-        jw.name("newWindow");
-        jw.value(obj.getFooterLink().getNewWindow());
-        jw.endObject();
+        gson.toJson(obj.getFooterLink(), obj.getFooterLink().getClass(), jw);
         if (!obj.isShowFooter()) jw.endArray();
     }
 
     @Override
     public FooterLinkContext read(JsonReader jr) throws IOException {
         throw new UnsupportedOperationException("JSON deserialization not supported for type FooterLinkContext.");
     }
-
-}
+}
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderAppTopTest.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderAppTopTest.java
@@ -6,6 +6,7 @@
 
 import org.junit.jupiter.api.Test;
 
+import goc.webtemplate.BannerLink;
 import goc.webtemplate.InfoBanner;
 import goc.webtemplate.Link;
 import goc.webtemplate.MenuItem;
@@ -32,7 +33,7 @@ public void testCustomMenuItem() {
     public void testInfoBanner() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
 
-        InfoBanner banner = new InfoBanner("Main Text", new Link("google", "Link"), new Link("yahoo", "Button"));
+        InfoBanner banner = new InfoBanner("Main Text", new BannerLink("google", "Link"), new BannerLink("yahoo", "Button"));
         sut.setInfoBanner(banner);
 
         assertTrue(sut.getRenderAppTop().contains("\"infoBanner\":{\"mainHTML\":\"Main Text\",\"link\":{\"href\":\"google\",\"text\":\"Link\",\"newWindow\":false},\"button\":{\"href\":\"yahoo\",\"text\":\"Button\",\"newWindow\":false}"),
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderFooterTest.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderFooterTest.java
@@ -7,6 +7,7 @@
 
 import org.junit.jupiter.api.Test;
 
+import goc.webtemplate.BannerLink;
 import goc.webtemplate.ContextualFooter;
 import goc.webtemplate.FooterLink;
 import goc.webtemplate.Link;
@@ -28,14 +29,13 @@ public void testHideMainCorporateFooter() {
     public void testShowContextualFooter() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
 
-        ContextualFooter f = new ContextualFooter();
-        List<Link> l = new ArrayList<Link>();
+        List<FooterLink> l = new ArrayList<FooterLink>();
 
-        l.add(new Link("google", "Link 1"));
-        l.add(new Link("google", "Link 2", true));
+        l.add(new FooterLink("google", "Link 1", false));
+        l.add(new FooterLink("google", "Link 2", true));
         sut.setContextualFooter(new ContextualFooter("Contextual", l));
 
-        assertTrue(sut.getRenderFooter().contains("\"contextualFooter\":{\"title\":\"Contextual\",\"links\":[{\"href\":\"google\",\"text\":\"Link 1\",\"newWindow\":false},{\"href\":\"google\",\"text\":\"Link 2\",\"newWindow\":true}]"),
+        assertTrue(sut.getRenderFooter().contains("\"contextualFooter\":{\"title\":\"Contextual\",\"links\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"Link 1\"},{\"newWindow\":true,\"href\":\"google\",\"text\":\"Link 2\"}]"),
                 "RenderFooter: ContextualFooter not rendered as expected.");
     }
 
@@ -49,7 +49,7 @@ public void testModifyTermsPrivacyLink() {
         sut.setPrivacyLink(new FooterLink("google"));
         sut.setTermsConditionsLink(new FooterLink("google"));
 
-        assertTrue(sut.getRenderFooter().contains("\"privacyLink\":{\"href\":\"google\",\"newWindow\":false},\"termsLink\":{\"href\":\"google\",\"newWindow\":false}"),
+        assertTrue(sut.getRenderFooter().contains("\"privacyLink\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"},\"termsLink\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}"),
                 "RenderFooter: PrivacyLink/TermsLinks not rendered as expected.");
     }
 
@@ -63,7 +63,7 @@ public void testModifyTermsProvacyLinkTransactionalFooter() {
         sut.setPrivacyLink(new FooterLink("google"));
         sut.setTermsConditionsLink(new FooterLink("google"));
 
-        assertTrue(sut.getRenderTransactionalFooter().contains("\"privacyLink\":[{\"href\":\"google\",\"newWindow\":false}],\"termsLink\":[{\"href\":\"google\",\"newWindow\":false}]"),
+        assertTrue(sut.getRenderTransactionalFooter().contains("\"privacyLink\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}],\"termsLink\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}]"),
                 "RenderTransactionalFooter: PrivacyLink/TermsLinks not rendered as expected.");
     }
 }
diff --git a/gocwebtemplate-sample-jsp/src/main/java/goc/webtemplate/jsp/samplebeans/FooterLinksSampleBean.java b/gocwebtemplate-sample-jsp/src/main/java/goc/webtemplate/jsp/samplebeans/FooterLinksSampleBean.java
@@ -18,5 +18,25 @@ public void onWebTemplateInitialize() {
         contactLinks.add(new Link("http://travel.gc.ca/", "Contact Travel!"));
         this.setContactLinks(contactLinks);
         */
+
+        /*
+        //Example of adding a contextual footer with 3 links
+        List<FooterLink> links = new ArrayList<FooterLink>();
+
+        links.add(new FooterLink("http://www.canada.ca/en/index.html", "Link 1", false));
+        links.add(new FooterLink("http://www.canada.ca/en/index.html", "Link 2", false));
+        links.add(new FooterLink("http://www.canada.ca/en/index.html", "Link 3", false));
+        this.setContextualFooter(new ContextualFooter("Title", links));
+        */
+
+        //Hiding the main footer
+        //this.setHideMainFooter(true);
+
+        //Hiding the corporate footer links
+        //this.setHideCorporateFooter(true);
+
+        //Overwriting the href of the privacy link and the terms and conditions link
+        //this.setPrivacyLink(new FooterLink("http://canada.ca/"));
+        //this.setTermsConditionsLink(new FooterLink("http://canada.ca/"));
     }
 }
diff --git a/gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/_sampleslist.jsp b/gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/_sampleslist.jsp
@@ -11,7 +11,7 @@
         <li><a href="errorsample.action">Unilingual Error Page</a></li>
         <li><a href="extendedbasepagesample.action">Extended Base Page</a></li>
         <li><a href="feedbackandsharethispagesample.action">Feedback and Share This Page Links</a></li>
-        <li><a href="footerlinkssample.action">Footer Links</a></li>
+        <li><a href="footerlinkssample.action">Footer</a></li>
         <li><a href="leavingsecureSitesample.action">Leaving Secure Site Warning</a></li>
         <li><a href="leftsidemenusample.action">Left Side Menu</a></li>
         <li><a href="nestedmasterpagesample.action">Nested Master Page</a></li>
diff --git a/gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/footerlinkssamplecontent.jsp b/gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/footerlinkssamplecontent.jsp
diff --git a/gocwebtemplate-sample-spring/src/main/java/goc/webtemplate/spring/samplebeans/FooterLinksSampleBean.java b/gocwebtemplate-sample-spring/src/main/java/goc/webtemplate/spring/samplebeans/FooterLinksSampleBean.java
diff --git a/gocwebtemplate-sample-spring/src/main/resources/samples/FooterLinksSample.html b/gocwebtemplate-sample-spring/src/main/resources/samples/FooterLinksSample.html
diff --git a/gocwebtemplate-sample-spring/src/main/resources/samples/_samplelist.html b/gocwebtemplate-sample-spring/src/main/resources/samples/_samplelist.html

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`public class ContextualFooter {`
`6`	`6`
`7`	`7`	`private String title;`
`8`		`- private List<Link> links;`
	`8`	`+ private List<FooterLink> links;`
`9`	`9`
`10`	`10`	`public ContextualFooter() {}`
`11`	`11`
`12`		`- public ContextualFooter(String title, List<Link> links)`
	`12`	`+ public ContextualFooter(String title, List<FooterLink> links)`
`13`	`13`	`{`
`14`	`14`	`this.title = title;`
`15`	`15`	`this.links = links;`
`@@ -23,11 +23,11 @@ public void setTitle(String title) {`
`23`	`23`	`this.title = title;`
`24`	`24`	`}`
`25`	`25`
`26`		`- public List<Link> getLinks() {`
	`26`	`+ public List<FooterLink> getLinks() {`
`27`	`27`	`return links;`
`28`	`28`	`}`
`29`	`29`
`30`		`- public void setLinks(List<Link> links) {`
	`30`	`+ public void setLinks(List<FooterLink> links) {`
`31`	`31`	`this.links = links;`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,12 @@`
`2`	`2`
`3`	`3`	`public class InfoBanner {`
`4`	`4`	`private String mainHTML;`
`5`		`- private Link link;`
`6`		`- private Link button;`
	`5`	`+ private BannerLink link;`
	`6`	`+ private BannerLink button;`
`7`	`7`
`8`	`8`	`public InfoBanner() {}`
`9`	`9`
`10`		`- public InfoBanner(String mainHTML, Link link, Link button)`
	`10`	`+ public InfoBanner(String mainHTML, BannerLink link, BannerLink button)`
`11`	`11`	`{`
`12`	`12`	`this.mainHTML = mainHTML;`
`13`	`13`	`this.link = link;`
`@@ -22,19 +22,19 @@ public void setMainHTML(String mainHTML) {`
`22`	`22`	`this.mainHTML = mainHTML;`
`23`	`23`	`}`
`24`	`24`
`25`		`- public Link getLink() {`
	`25`	`+ public BannerLink getLink() {`
`26`	`26`	`return link;`
`27`	`27`	`}`
`28`	`28`
`29`		`- public void setLink(Link link) {`
	`29`	`+ public void setLink(BannerLink link) {`
`30`	`30`	`this.link = link;`
`31`	`31`	`}`
`32`	`32`
`33`		`- public Link getButton() {`
	`33`	`+ public BannerLink getButton() {`
`34`	`34`	`return button;`
`35`	`35`	`}`
`36`	`36`
`37`		`- public void setButton(Link button) {`
	`37`	`+ public void setButton(BannerLink button) {`
`38`	`38`	`this.button = button;`
`39`	`39`	`}`
`40`	`40`	`}`