Add JSS class to replace TomcatJSS

edewata · edewata · commit 489582dba273 · 2025-03-06T18:43:30.000-06:00
The JSS class has been added to replace TomcatJSS class since
Tomcat JSS project has been merged into JSS.
diff --git a/docs/changes/v5.7.0/API-Changes.adoc b/docs/changes/v5.7.0/API-Changes.adoc
@@ -0,0 +1,6 @@
+= API Changes =
+
+== Deprecate TomcatJSS ==
+
+The `org.dogtagpki.jss.tomcat.TomcatJSS` has been deprecated and will be removed in the future.
+Use `org.dogtagpki.jss.JSS` instead.
diff --git a/tomcat-9.0/src/main/java/org/dogtagpki/jss/tomcat/Http11NioProtocol.java b/tomcat-9.0/src/main/java/org/dogtagpki/jss/tomcat/Http11NioProtocol.java
@@ -27,6 +27,7 @@
 import org.apache.juli.logging.Log;
 import org.apache.juli.logging.LogFactory;
 import org.apache.tomcat.util.net.NioChannel;
+import org.dogtagpki.jss.JSS;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -35,106 +36,106 @@ public class Http11NioProtocol extends AbstractHttp11JsseProtocol<NioChannel> {
     public static Logger logger = LoggerFactory.getLogger(Http11NioProtocol.class);
     private static final Log log = LogFactory.getLog(Http11NioProtocol.class);
 
-    TomcatJSS tomcatjss = TomcatJSS.getInstance();
+    JSS jss = JSS.getInstance();
 
     public Http11NioProtocol() {
        super(new JSSNioEndpoint());
     }
 
     public String getCertdbDir() {
-        return tomcatjss.getCertdbDir();
+        return jss.getCertdbDir();
     }
 
     public void setCertdbDir(String certdbDir) {
-        tomcatjss.setCertdbDir(certdbDir);
+        jss.setCertdbDir(certdbDir);
     }
 
     public String getPasswordClass() {
-        return tomcatjss.getPasswordClass();
+        return jss.getPasswordClass();
     }
 
     public void setPasswordClass(String passwordClass) {
-        tomcatjss.setPasswordClass(passwordClass);
+        jss.setPasswordClass(passwordClass);
     }
 
     public String getPasswordFile() {
-        return tomcatjss.getPasswordFile();
+        return jss.getPasswordFile();
     }
 
     public void setPasswordFile(String passwordFile) {
-        tomcatjss.setPasswordFile(passwordFile);
+        jss.setPasswordFile(passwordFile);
     }
 
     public String getServerCertNickFile() {
-        return tomcatjss.getServerCertNickFile();
+        return jss.getServerCertNickFile();
     }
 
     public void setServerCertNickFile(String serverCertNickFile) {
-        tomcatjss.setServerCertNickFile(serverCertNickFile);
+        jss.setServerCertNickFile(serverCertNickFile);
     }
 
     public boolean getEnableOCSP() {
-        return tomcatjss.getEnableRevocationCheck();
+        return jss.getEnableRevocationCheck();
     }
 
     public void setEnableOCSP(boolean enableOCSP) {
-        tomcatjss.setEnableRevocationCheck(enableOCSP);
+        jss.setEnableRevocationCheck(enableOCSP);
     }
 
     public boolean getEnableRevocationCheck() {
-        return tomcatjss.getEnableRevocationCheck();
+        return jss.getEnableRevocationCheck();
     }
-    
+
     public void setEnableRevocationCheck(boolean enableRevocationCheck) {
-        tomcatjss.setEnableRevocationCheck(enableRevocationCheck);
+        jss.setEnableRevocationCheck(enableRevocationCheck);
     }
 
     public String getOcspResponderURL() {
-        return tomcatjss.getOcspResponderURL();
+        return jss.getOcspResponderURL();
     }
 
     public void setOcspResponderURL(String ocspResponderURL) {
-        tomcatjss.setOcspResponderURL(ocspResponderURL);
+        jss.setOcspResponderURL(ocspResponderURL);
     }
 
     public String getOcspResponderCertNickname() {
-        return tomcatjss.getOcspResponderCertNickname();
+        return jss.getOcspResponderCertNickname();
     }
 
     public void setOcspResponderCertNickname(String ocspResponderCertNickname) {
-        tomcatjss.setOcspResponderCertNickname(ocspResponderCertNickname);
+        jss.setOcspResponderCertNickname(ocspResponderCertNickname);
     }
 
     public int getOcspCacheSize() {
-        return tomcatjss.getOcspCacheSize();
+        return jss.getOcspCacheSize();
     }
 
     public void setOcspCacheSize(int ocspCacheSize) {
-        tomcatjss.setOcspCacheSize(ocspCacheSize);
+        jss.setOcspCacheSize(ocspCacheSize);
     }
 
     public int getOcspMinCacheEntryDuration() {
-        return tomcatjss.getOcspMinCacheEntryDuration();
+        return jss.getOcspMinCacheEntryDuration();
     }
 
     public void setOcspMinCacheEntryDuration(int ocspMinCacheEntryDuration) {
-        tomcatjss.setOcspMinCacheEntryDuration(ocspMinCacheEntryDuration);
+        jss.setOcspMinCacheEntryDuration(ocspMinCacheEntryDuration);
     }
 
     public int getOcspMaxCacheEntryDuration() {
-        return tomcatjss.getOcspMaxCacheEntryDuration();
+        return jss.getOcspMaxCacheEntryDuration();
     }
 
     public void setOcspMaxCacheEntryDuration(int ocspMaxCacheEntryDuration) {
-        tomcatjss.setOcspMaxCacheEntryDuration(ocspMaxCacheEntryDuration);
+        jss.setOcspMaxCacheEntryDuration(ocspMaxCacheEntryDuration);
     }
 
     public int getOcspTimeout() {
-        return tomcatjss.getOcspTimeout();
+        return jss.getOcspTimeout();
     }
 
     public void setOcspTimeout(int ocspTimeout) {
-        tomcatjss.setOcspTimeout(ocspTimeout);
+        jss.setOcspTimeout(ocspTimeout);
     }
 
     public void setKeystorePassFile(String keystorePassFile) {
diff --git a/tomcat-9.0/src/main/java/org/dogtagpki/jss/tomcat/JSSContext.java b/tomcat-9.0/src/main/java/org/dogtagpki/jss/tomcat/JSSContext.java
@@ -8,6 +8,7 @@
 import javax.net.ssl.TrustManager;
 import javax.net.ssl.TrustManagerFactory;
 
+import org.dogtagpki.jss.JSS;
 import org.mozilla.jss.JSSProvider;
 import org.mozilla.jss.provider.javax.crypto.JSSKeyManager;
 import org.mozilla.jss.provider.javax.crypto.JSSTrustManager;
@@ -63,13 +64,13 @@ public javax.net.ssl.SSLEngine createSSLEngine() {
         logger.debug("JSSContext.createSSLEngine()");
         javax.net.ssl.SSLEngine eng = ctx.createSSLEngine();
 
-	TomcatJSS instance = TomcatJSS.getInstance();
+        JSS jss = JSS.getInstance();
 
         if (eng instanceof JSSEngine) {
             JSSEngine j_eng = (JSSEngine) eng;
             j_eng.setCertFromAlias(alias);
-            if(instance != null) {
-                j_eng.setListeners(instance.getSocketListeners());
+            if(jss != null) {
+                j_eng.setListeners(jss.getSocketListeners());
             }
         }
 
diff --git a/tomcat-9.0/src/main/java/org/dogtagpki/jss/tomcat/JSSListener.java b/tomcat-9.0/src/main/java/org/dogtagpki/jss/tomcat/JSSListener.java
@@ -22,6 +22,7 @@
 import org.apache.catalina.Lifecycle;
 import org.apache.catalina.LifecycleEvent;
 import org.apache.catalina.LifecycleListener;
+import org.dogtagpki.jss.JSS;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -51,12 +52,12 @@ public void lifecycleEvent(LifecycleEvent event) {
 
     public void initJSS() {
 
-        logger.info("JSSListener: Initializing JSS");
+        logger.info("JSSListener: Initializing JSS connector");
 
         try {
-            TomcatJSS tomcatjss = TomcatJSS.getInstance();
-            tomcatjss.loadConfig();
-            tomcatjss.init();
+            JSS jss = JSS.getInstance();
+            jss.loadConfig();
+            jss.init();
 
         } catch (Exception e) {
             throw new RuntimeException(e);
diff --git a/tomcat/src/main/java/org/dogtagpki/jss/JSS.java b/tomcat/src/main/java/org/dogtagpki/jss/JSS.java
@@ -0,0 +1,23 @@
+//
+// Copyright Red Hat, Inc.
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+//
+package org.dogtagpki.jss;
+
+import org.dogtagpki.jss.tomcat.TomcatJSS;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * This class provides a mechanism to initialize JSS in Tomcat.
+ * It inherits from TomcatJSS for backward compatibility.
+ */
+public class JSS extends TomcatJSS {
+
+    public static final Logger logger = LoggerFactory.getLogger(JSS.class);
+
+    public static final JSS INSTANCE = new JSS();
+
+    public static JSS getInstance() { return INSTANCE; }
+}
diff --git a/tomcat/src/main/java/org/dogtagpki/jss/tomcat/TomcatJSS.java b/tomcat/src/main/java/org/dogtagpki/jss/tomcat/TomcatJSS.java

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@`
`27`	`27`	`import org.apache.juli.logging.Log;`
`28`	`28`	`import org.apache.juli.logging.LogFactory;`
`29`	`29`	`import org.apache.tomcat.util.net.NioChannel;`
	`30`	`+import org.dogtagpki.jss.JSS;`
`30`	`31`	`import org.slf4j.Logger;`
`31`	`32`	`import org.slf4j.LoggerFactory;`
`32`	`33`
`@@ -35,106 +36,106 @@ public class Http11NioProtocol extends AbstractHttp11JsseProtocol<NioChannel> {`
`35`	`36`	`public static Logger logger = LoggerFactory.getLogger(Http11NioProtocol.class);`
`36`	`37`	`private static final Log log = LogFactory.getLog(Http11NioProtocol.class);`
`37`	`38`
`38`		`- TomcatJSS tomcatjss = TomcatJSS.getInstance();`
	`39`	`+ JSS jss = JSS.getInstance();`
`39`	`40`
`40`	`41`	`public Http11NioProtocol() {`
`41`	`42`	`super(new JSSNioEndpoint());`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`public String getCertdbDir() {`
`45`		`- return tomcatjss.getCertdbDir();`
	`46`	`+ return jss.getCertdbDir();`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`public void setCertdbDir(String certdbDir) {`
`49`		`- tomcatjss.setCertdbDir(certdbDir);`
	`50`	`+ jss.setCertdbDir(certdbDir);`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`public String getPasswordClass() {`
`53`		`- return tomcatjss.getPasswordClass();`
	`54`	`+ return jss.getPasswordClass();`
`54`	`55`	`}`
`55`	`56`
`56`	`57`	`public void setPasswordClass(String passwordClass) {`
`57`		`- tomcatjss.setPasswordClass(passwordClass);`
	`58`	`+ jss.setPasswordClass(passwordClass);`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`public String getPasswordFile() {`
`61`		`- return tomcatjss.getPasswordFile();`
	`62`	`+ return jss.getPasswordFile();`
`62`	`63`	`}`
`63`	`64`
`64`	`65`	`public void setPasswordFile(String passwordFile) {`
`65`		`- tomcatjss.setPasswordFile(passwordFile);`
	`66`	`+ jss.setPasswordFile(passwordFile);`
`66`	`67`	`}`
`67`	`68`
`68`	`69`	`public String getServerCertNickFile() {`
`69`		`- return tomcatjss.getServerCertNickFile();`
	`70`	`+ return jss.getServerCertNickFile();`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`public void setServerCertNickFile(String serverCertNickFile) {`
`73`		`- tomcatjss.setServerCertNickFile(serverCertNickFile);`
	`74`	`+ jss.setServerCertNickFile(serverCertNickFile);`
`74`	`75`	`}`
`75`	`76`
`76`	`77`	`public boolean getEnableOCSP() {`
`77`		`- return tomcatjss.getEnableRevocationCheck();`
	`78`	`+ return jss.getEnableRevocationCheck();`
`78`	`79`	`}`
`79`	`80`
`80`	`81`	`public void setEnableOCSP(boolean enableOCSP) {`
`81`		`- tomcatjss.setEnableRevocationCheck(enableOCSP);`
	`82`	`+ jss.setEnableRevocationCheck(enableOCSP);`
`82`	`83`	`}`
`83`	`84`
`84`	`85`	`public boolean getEnableRevocationCheck() {`
`85`		`- return tomcatjss.getEnableRevocationCheck();`
	`86`	`+ return jss.getEnableRevocationCheck();`
`86`	`87`	`}`
`87`		`-`
	`88`	`+`
`88`	`89`	`public void setEnableRevocationCheck(boolean enableRevocationCheck) {`
`89`		`- tomcatjss.setEnableRevocationCheck(enableRevocationCheck);`
	`90`	`+ jss.setEnableRevocationCheck(enableRevocationCheck);`
`90`	`91`	`}`
`91`	`92`
`92`	`93`	`public String getOcspResponderURL() {`
`93`		`- return tomcatjss.getOcspResponderURL();`
	`94`	`+ return jss.getOcspResponderURL();`
`94`	`95`	`}`
`95`	`96`
`96`	`97`	`public void setOcspResponderURL(String ocspResponderURL) {`
`97`		`- tomcatjss.setOcspResponderURL(ocspResponderURL);`
	`98`	`+ jss.setOcspResponderURL(ocspResponderURL);`
`98`	`99`	`}`
`99`	`100`
`100`	`101`	`public String getOcspResponderCertNickname() {`
`101`		`- return tomcatjss.getOcspResponderCertNickname();`
	`102`	`+ return jss.getOcspResponderCertNickname();`
`102`	`103`	`}`
`103`	`104`
`104`	`105`	`public void setOcspResponderCertNickname(String ocspResponderCertNickname) {`
`105`		`- tomcatjss.setOcspResponderCertNickname(ocspResponderCertNickname);`
	`106`	`+ jss.setOcspResponderCertNickname(ocspResponderCertNickname);`
`106`	`107`	`}`
`107`	`108`
`108`	`109`	`public int getOcspCacheSize() {`
`109`		`- return tomcatjss.getOcspCacheSize();`
	`110`	`+ return jss.getOcspCacheSize();`
`110`	`111`	`}`
`111`	`112`
`112`	`113`	`public void setOcspCacheSize(int ocspCacheSize) {`
`113`		`- tomcatjss.setOcspCacheSize(ocspCacheSize);`
	`114`	`+ jss.setOcspCacheSize(ocspCacheSize);`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`public int getOcspMinCacheEntryDuration() {`
`117`		`- return tomcatjss.getOcspMinCacheEntryDuration();`
	`118`	`+ return jss.getOcspMinCacheEntryDuration();`
`118`	`119`	`}`
`119`	`120`
`120`	`121`	`public void setOcspMinCacheEntryDuration(int ocspMinCacheEntryDuration) {`
`121`		`- tomcatjss.setOcspMinCacheEntryDuration(ocspMinCacheEntryDuration);`
	`122`	`+ jss.setOcspMinCacheEntryDuration(ocspMinCacheEntryDuration);`
`122`	`123`	`}`
`123`	`124`
`124`	`125`	`public int getOcspMaxCacheEntryDuration() {`
`125`		`- return tomcatjss.getOcspMaxCacheEntryDuration();`
	`126`	`+ return jss.getOcspMaxCacheEntryDuration();`
`126`	`127`	`}`
`127`	`128`
`128`	`129`	`public void setOcspMaxCacheEntryDuration(int ocspMaxCacheEntryDuration) {`
`129`		`- tomcatjss.setOcspMaxCacheEntryDuration(ocspMaxCacheEntryDuration);`
	`130`	`+ jss.setOcspMaxCacheEntryDuration(ocspMaxCacheEntryDuration);`
`130`	`131`	`}`
`131`	`132`
`132`	`133`	`public int getOcspTimeout() {`
`133`		`- return tomcatjss.getOcspTimeout();`
	`134`	`+ return jss.getOcspTimeout();`
`134`	`135`	`}`
`135`	`136`
`136`	`137`	`public void setOcspTimeout(int ocspTimeout) {`
`137`		`- tomcatjss.setOcspTimeout(ocspTimeout);`
	`138`	`+ jss.setOcspTimeout(ocspTimeout);`
`138`	`139`	`}`
`139`	`140`
`140`	`141`	`public void setKeystorePassFile(String keystorePassFile) {`