use SurenessConstant instead of common str (#90)

core/src/main/java/com/usthe/sureness/handler/AttachSessionServletHandler.java

 package com.usthe.sureness.handler;
 
 import com.usthe.sureness.subject.SubjectSum;
+import com.usthe.sureness.util.SurenessConstant;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
@@ -12,19 +13,15 @@ import javax.servlet.http.HttpSession;
  */
 public class AttachSessionServletHandler implements SuccessHandler{
 
-    private static final String PRINCIPAL = "principal";
-    private static final String PRINCIPALS = "principals";
-    private static final String ROLES = "roles";
-
     @Override
     public void processHandler(SubjectSum subjectSum, Object request) {
         if (request instanceof HttpServletRequest) {
             HttpServletRequest servletRequest = (HttpServletRequest) request;
             HttpSession httpSession = servletRequest.getSession();
-            if (httpSession.isNew() || httpSession.getAttribute(PRINCIPAL) == null) {
-                httpSession.setAttribute(PRINCIPAL, subjectSum.getPrincipal());
-                httpSession.setAttribute(PRINCIPALS, subjectSum.getPrincipalMap());
-                httpSession.setAttribute(ROLES, subjectSum.getRoles());
+            if (httpSession.isNew() || httpSession.getAttribute(SurenessConstant.PRINCIPAL) == null) {
+                httpSession.setAttribute(SurenessConstant.PRINCIPAL, subjectSum.getPrincipal());
+                httpSession.setAttribute(SurenessConstant.PRINCIPALS, subjectSum.getPrincipalMap());
+                httpSession.setAttribute(SurenessConstant.ROLES, subjectSum.getRoles());
             }
         }
 

core/src/main/java/com/usthe/sureness/subject/creater/BasicSubjectJaxRsCreator.java

@@ -3,6 +3,7 @@ package com.usthe.sureness.subject.creater;
 import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.PasswordSubject;
+import com.usthe.sureness.util.SurenessConstant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -20,16 +21,14 @@ public class BasicSubjectJaxRsCreator implements SubjectCreate {
 
     private static final Logger logger = LoggerFactory.getLogger(BasicSubjectJaxRsCreator.class);
 
-    private static final String AUTHORIZATION = "Authorization";
-    private static final String BASIC = "Basic";
     private static final int COUNT_2 = 2;
 
     @Override
     public boolean canSupportSubject(Object context) {
         // ("Authorization", "Basic YWRtaW46YWRtaW4=")        --- basic auth
         if (context instanceof ContainerRequestContext) {
-            String authorization = ((ContainerRequestContext)context).getHeaderString(AUTHORIZATION);
-            return authorization != null && authorization.startsWith(BASIC);
+            String authorization = ((ContainerRequestContext)context).getHeaderString(SurenessConstant.AUTHORIZATION);
+            return authorization != null && authorization.startsWith(SurenessConstant.BASIC);
         } else {
             return false;
         }
@@ -37,9 +36,9 @@ public class BasicSubjectJaxRsCreator implements SubjectCreate {
 
     @Override
     public Subject createSubject(Object context) {
-        String authorization = ((ContainerRequestContext)context).getHeaderString(AUTHORIZATION);
+        String authorization = ((ContainerRequestContext)context).getHeaderString(SurenessConstant.AUTHORIZATION);
         //basic auth
-        String basicAuth = authorization.replace(BASIC, "").trim();
+        String basicAuth = authorization.replace(SurenessConstant.BASIC, "").trim();
         try {
             basicAuth = new String(Base64.getDecoder().decode(basicAuth), StandardCharsets.UTF_8);
         } catch (Exception e) {

core/src/main/java/com/usthe/sureness/subject/creater/BasicSubjectServletCreator.java

@@ -3,6 +3,7 @@ package com.usthe.sureness.subject.creater;
 import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.PasswordSubject;
+import com.usthe.sureness.util.SurenessConstant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -20,16 +21,14 @@ public class BasicSubjectServletCreator implements SubjectCreate {
 
     private static final Logger logger = LoggerFactory.getLogger(BasicSubjectServletCreator.class);
 
-    private static final String AUTHORIZATION = "Authorization";
-    private static final String BASIC = "Basic";
     private static final int COUNT_2 = 2;
 
     @Override
     public boolean canSupportSubject(Object context) {
         // ("Authorization", "Basic YWRtaW46YWRtaW4=")        --- basic auth
         if (context instanceof HttpServletRequest) {
-            String authorization = ((HttpServletRequest)context).getHeader(AUTHORIZATION);
-            return authorization != null && authorization.startsWith(BASIC);
+            String authorization = ((HttpServletRequest)context).getHeader(SurenessConstant.AUTHORIZATION);
+            return authorization != null && authorization.startsWith(SurenessConstant.BASIC);
         } else {
             return false;
         }
@@ -37,9 +36,9 @@ public class BasicSubjectServletCreator implements SubjectCreate {
 
     @Override
     public Subject createSubject(Object context) {
-        String authorization = ((HttpServletRequest)context).getHeader(AUTHORIZATION);
+        String authorization = ((HttpServletRequest)context).getHeader(SurenessConstant.AUTHORIZATION);
         //basic auth
-        String basicAuth = authorization.replace(BASIC, "").trim();
+        String basicAuth = authorization.replace(SurenessConstant.BASIC, "").trim();
         try {
             basicAuth = new String(Base64.getDecoder().decode(basicAuth), StandardCharsets.UTF_8);
         } catch (Exception e) {

core/src/main/java/com/usthe/sureness/subject/creater/DigestSubjectJaxRsCreator.java

@@ -3,6 +3,7 @@ package com.usthe.sureness.subject.creater;
 import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.DigestSubject;
+import com.usthe.sureness.util.SurenessConstant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -21,8 +22,6 @@ public class DigestSubjectJaxRsCreator implements SubjectCreate {
 
     private static final Logger logger = LoggerFactory.getLogger(DigestSubjectJaxRsCreator.class);
 
-    private static final String AUTHORIZATION = "Authorization";
-    private static final String DIGEST = "Digest ";
     private static final String USERNAME = "username";
     private static final String NONCE = "nonce";
     private static final String QOP = "qop";
@@ -37,8 +36,8 @@ public class DigestSubjectJaxRsCreator implements SubjectCreate {
     @Override
     public boolean canSupportSubject(Object context) {
         if (context instanceof ContainerRequestContext) {
-            String authorization = ((ContainerRequestContext)context).getHeaderString(AUTHORIZATION);
-            return authorization == null || authorization.startsWith(DIGEST);
+            String authorization = ((ContainerRequestContext)context).getHeaderString(SurenessConstant.AUTHORIZATION);
+            return authorization == null || authorization.startsWith(SurenessConstant.DIGEST);
         } else {
             return false;
         }
@@ -46,12 +45,12 @@ public class DigestSubjectJaxRsCreator implements SubjectCreate {
 
     @Override
     public Subject createSubject(Object context) {
-        String authorization = ((ContainerRequestContext)context).getHeaderString(AUTHORIZATION);
+        String authorization = ((ContainerRequestContext)context).getHeaderString(SurenessConstant.AUTHORIZATION);
         if (authorization == null) {
             return new DigestSubject();
         } else {
             // digest auth
-            String digestAuth = authorization.replace(DIGEST, "").trim();
+            String digestAuth = authorization.replace(SurenessConstant.DIGEST, "").trim();
             try {
                 final Map<String, String> digestMap = new HashMap<>(8);
                 Arrays.stream(digestAuth.split(",")).forEach(auth -> {

core/src/main/java/com/usthe/sureness/subject/creater/DigestSubjectServletCreator.java

@@ -3,6 +3,7 @@ package com.usthe.sureness.subject.creater;
 import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.DigestSubject;
+import com.usthe.sureness.util.SurenessConstant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -21,8 +22,6 @@ public class DigestSubjectServletCreator implements SubjectCreate {
 
     private static final Logger logger = LoggerFactory.getLogger(DigestSubjectServletCreator.class);
 
-    private static final String AUTHORIZATION = "Authorization";
-    private static final String DIGEST = "Digest ";
     private static final String USERNAME = "username";
     private static final String NONCE = "nonce";
     private static final String QOP = "qop";
@@ -37,8 +36,8 @@ public class DigestSubjectServletCreator implements SubjectCreate {
     @Override
     public boolean canSupportSubject(Object context) {
         if (context instanceof HttpServletRequest) {
-            String authorization = ((HttpServletRequest)context).getHeader(AUTHORIZATION);
-            return authorization == null || authorization.startsWith(DIGEST);
+            String authorization = ((HttpServletRequest)context).getHeader(SurenessConstant.AUTHORIZATION);
+            return authorization == null || authorization.startsWith(SurenessConstant.DIGEST);
         } else {
             return false;
         }
@@ -46,12 +45,12 @@ public class DigestSubjectServletCreator implements SubjectCreate {
 
     @Override
     public Subject createSubject(Object context) {
-        String authorization = ((HttpServletRequest)context).getHeader(AUTHORIZATION);
+        String authorization = ((HttpServletRequest)context).getHeader(SurenessConstant.AUTHORIZATION);
         if (authorization == null) {
             return new DigestSubject();
         } else {
             // digest auth
-            String digestAuth = authorization.replace(DIGEST, "").trim();
+            String digestAuth = authorization.replace(SurenessConstant.DIGEST, "").trim();
             try {
                 final Map<String, String> digestMap = new HashMap<>(8);
                 Arrays.stream(digestAuth.split(",")).forEach(auth -> {

core/src/main/java/com/usthe/sureness/subject/creater/JwtSubjectJaxRsCreator.java

@@ -4,6 +4,7 @@ import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.JwtSubject;
 import com.usthe.sureness.util.JsonWebTokenUtil;
+import com.usthe.sureness.util.SurenessConstant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -20,17 +21,14 @@ public class JwtSubjectJaxRsCreator implements SubjectCreate {
 
     private static final Logger logger = LoggerFactory.getLogger(JwtSubjectJaxRsCreator.class);
 
-    private static final String BEARER = "Bearer";
-    private static final String AUTHORIZATION = "Authorization";
-
     @Override
     public boolean canSupportSubject(Object context) {
         // support bearer jwt
         // ("Authorization", "Bearer eyJhbGciOiJIUzUxMi...")  --- jwt auth
         if (context instanceof ContainerRequestContext) {
-            String authorization = ((ContainerRequestContext)context).getHeaderString(AUTHORIZATION);
-            if (authorization != null && authorization.startsWith(BEARER)) {
-                String jwtValue = authorization.replace(BEARER, "").trim();
+            String authorization = ((ContainerRequestContext)context).getHeaderString(SurenessConstant.AUTHORIZATION);
+            if (authorization != null && authorization.startsWith(SurenessConstant.BEARER)) {
+                String jwtValue = authorization.replace(SurenessConstant.BEARER, "").trim();
                 return !JsonWebTokenUtil.isNotJsonWebToken(jwtValue);
             }
         }
@@ -39,10 +37,10 @@ public class JwtSubjectJaxRsCreator implements SubjectCreate {
 
     @Override
     public Subject createSubject(Object context) {
-        String authorization = ((ContainerRequestContext)context).getHeaderString(AUTHORIZATION);
-        if (authorization != null && authorization.startsWith(BEARER)) {
+        String authorization = ((ContainerRequestContext)context).getHeaderString(SurenessConstant.AUTHORIZATION);
+        if (authorization != null && authorization.startsWith(SurenessConstant.BEARER)) {
             // jwt token
-            String jwtValue = authorization.replace(BEARER, "").trim();
+            String jwtValue = authorization.replace(SurenessConstant.BEARER, "").trim();
             if (JsonWebTokenUtil.isNotJsonWebToken(jwtValue)) {
                 if (logger.isInfoEnabled()) {
                     logger.info("can not create JwtSubject by this request message, is not jwt");

core/src/main/java/com/usthe/sureness/subject/creater/JwtSubjectServletCreator.java

@@ -4,6 +4,7 @@ import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.JwtSubject;
 import com.usthe.sureness.util.JsonWebTokenUtil;
+import com.usthe.sureness.util.SurenessConstant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -19,17 +20,14 @@ public class JwtSubjectServletCreator implements SubjectCreate {
 
     private static final Logger logger = LoggerFactory.getLogger(JwtSubjectServletCreator.class);
 
-    private static final String BEARER = "Bearer";
-    private static final String AUTHORIZATION = "Authorization";
-
     @Override
     public boolean canSupportSubject(Object context) {
         // support bearer jwt
         // ("Authorization", "Bearer eyJhbGciOiJIUzUxMi...")  --- jwt auth
         if (context instanceof HttpServletRequest) {
-            String authorization = ((HttpServletRequest)context).getHeader(AUTHORIZATION);
-            if (authorization != null && authorization.startsWith(BEARER)) {
-                String jwtValue = authorization.replace(BEARER, "").trim();
+            String authorization = ((HttpServletRequest)context).getHeader(SurenessConstant.AUTHORIZATION);
+            if (authorization != null && authorization.startsWith(SurenessConstant.BEARER)) {
+                String jwtValue = authorization.replace(SurenessConstant.BEARER, "").trim();
                 return !JsonWebTokenUtil.isNotJsonWebToken(jwtValue);
             }
         }
@@ -38,10 +36,10 @@ public class JwtSubjectServletCreator implements SubjectCreate {
 
     @Override
     public Subject createSubject(Object context) {
-        String authorization = ((HttpServletRequest)context).getHeader(AUTHORIZATION);
-        if (authorization != null && authorization.startsWith(BEARER)) {
+        String authorization = ((HttpServletRequest)context).getHeader(SurenessConstant.AUTHORIZATION);
+        if (authorization != null && authorization.startsWith(SurenessConstant.BEARER)) {
             // jwt token
-            String jwtValue = authorization.replace(BEARER, "").trim();
+            String jwtValue = authorization.replace(SurenessConstant.BEARER, "").trim();
             if (JsonWebTokenUtil.isNotJsonWebToken(jwtValue)) {
                 if (logger.isInfoEnabled()) {
                     logger.info("can not create JwtSubject by this request message, is not jwt");

core/src/main/java/com/usthe/sureness/subject/creater/JwtSubjectWsJaxRsCreator.java

@@ -4,6 +4,7 @@ import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.JwtSubject;
 import com.usthe.sureness.util.JsonWebTokenUtil;
+import com.usthe.sureness.util.SurenessConstant;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.container.ContainerRequestContext;
@@ -16,14 +17,12 @@ import javax.ws.rs.container.ContainerRequestContext;
  */
 public class JwtSubjectWsJaxRsCreator implements SubjectCreate {
 
-    private static final String TOKEN = "token";
-
     @Override
     public boolean canSupportSubject(Object context) {
         // support token jwt
         // requestUri?token=jwt0-eyJhbGciOiJIUzUxMi --- jwt auth
         if (context instanceof ContainerRequestContext) {
-            Object token = ((ContainerRequestContext)context).getProperty(TOKEN);
+            Object token = ((ContainerRequestContext)context).getProperty(SurenessConstant.TOKEN);
             return token instanceof String && !JsonWebTokenUtil.isNotJsonWebToken((String) token);
         }
         return false;
@@ -33,7 +32,7 @@ public class JwtSubjectWsJaxRsCreator implements SubjectCreate {
     public Subject createSubject(Object context) {
         // support token jwt
         // requestUri?token=jwt0-eyJhbGciOiJIUzUxMi --- jwt auth
-        Object token = ((ContainerRequestContext)context).getProperty(TOKEN);
+        Object token = ((ContainerRequestContext)context).getProperty(SurenessConstant.TOKEN);
         if (token instanceof String) {
             String jwtToken = ((String)token).trim();
             String remoteHost = ((HttpServletRequest) context).getRemoteHost();

core/src/main/java/com/usthe/sureness/subject/creater/JwtSubjectWsServletCreator.java

@@ -4,6 +4,7 @@ import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.JwtSubject;
 import com.usthe.sureness.util.JsonWebTokenUtil;
+import com.usthe.sureness.util.SurenessConstant;
 
 import javax.servlet.http.HttpServletRequest;
 
@@ -15,14 +16,12 @@ import javax.servlet.http.HttpServletRequest;
  */
 public class JwtSubjectWsServletCreator implements SubjectCreate {
 
-    private static final String TOKEN = "token";
-
     @Override
     public boolean canSupportSubject(Object context) {
         // support token jwt
         // requestUri?token=jwt0-eyJhbGciOiJIUzUxMi --- jwt auth
         if (context instanceof HttpServletRequest) {
-            String token = ((HttpServletRequest)context).getParameter(TOKEN);
+            String token = ((HttpServletRequest)context).getParameter(SurenessConstant.TOKEN);
             return !JsonWebTokenUtil.isNotJsonWebToken(token);
         }
         return false;
@@ -32,7 +31,7 @@ public class JwtSubjectWsServletCreator implements SubjectCreate {
     public Subject createSubject(Object context) {
         // support token jwt
         // requestUri?token=jwt0-eyJhbGciOiJIUzUxMi --- jwt auth
-        String jwtToken = ((HttpServletRequest)context).getParameter(TOKEN);
+        String jwtToken = ((HttpServletRequest)context).getParameter(SurenessConstant.TOKEN);
         if (jwtToken != null) {
             jwtToken = jwtToken.trim();
             String remoteHost = ((HttpServletRequest) context).getRemoteHost();

core/src/main/java/com/usthe/sureness/subject/creater/SessionSubjectServletCreator.java

@@ -4,6 +4,7 @@ import com.usthe.sureness.subject.PrincipalMap;
 import com.usthe.sureness.subject.Subject;
 import com.usthe.sureness.subject.SubjectCreate;
 import com.usthe.sureness.subject.support.SessionSubject;
+import com.usthe.sureness.util.SurenessConstant;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
@@ -16,15 +17,11 @@ import java.util.List;
  */
 public class SessionSubjectServletCreator implements SubjectCreate {
 
-    private static final String PRINCIPAL = "principal";
-    private static final String PRINCIPALS = "principals";
-    private static final String ROLES = "roles";
-
     @Override
     public boolean canSupportSubject(Object context) {
         if (context instanceof HttpServletRequest) {
             HttpSession httpSession = ((HttpServletRequest) context).getSession(false);
-            return httpSession != null && httpSession.getAttribute(PRINCIPAL) != null;
+            return httpSession != null && httpSession.getAttribute(SurenessConstant.PRINCIPAL) != null;
         } else {
             return false;
         }
@@ -35,13 +32,13 @@ public class SessionSubjectServletCreator implements SubjectCreate {
     public Subject createSubject(Object context) {
         HttpServletRequest servletRequest = (HttpServletRequest) context;
         HttpSession httpSession = servletRequest.getSession(false);
-        String principal = (String) httpSession.getAttribute(PRINCIPAL);
+        String principal = (String) httpSession.getAttribute(SurenessConstant.PRINCIPAL);
         if (principal == null || "".equals(principal.trim())) {
             return null;
         }
-        Object principalMapTmp = httpSession.getAttribute(PRINCIPALS);
+        Object principalMapTmp = httpSession.getAttribute(SurenessConstant.PRINCIPALS);
         PrincipalMap principalMap = principalMapTmp == null ? null : (PrincipalMap) principalMapTmp;
-        Object rolesTmp = httpSession.getAttribute(ROLES);
+        Object rolesTmp = httpSession.getAttribute(SurenessConstant.ROLES);
         List<String> roles = rolesTmp == null ? null : (List<String>) rolesTmp;
         String remoteHost = ((HttpServletRequest) context).getRemoteHost();
         String requestUri = ((HttpServletRequest) context).getRequestURI();

core/src/main/java/com/usthe/sureness/util/JsonWebTokenUtil.java

@@ -59,7 +59,7 @@ public class JsonWebTokenUtil {
                                   List<String> roles, List<String> permissions,
                                   Boolean isRefresh) {
         Map<String, Object> customClaimMap = new HashMap<>(4);
-        customClaimMap.put("roles", roles);
+        customClaimMap.put(SurenessConstant.ROLES, roles);
         customClaimMap.put("perms", permissions);
         customClaimMap.put("isRefresh", isRefresh);
         return issueJwtAll(id, subject, issuer, period, null, null,
@@ -76,7 +76,7 @@ public class JsonWebTokenUtil {
      * @return java.lang.String jwt
      */
     public static String issueJwt(String id, String subject, String issuer, Long period, List<String> roles) {
-        Map<String, Object> customClaimMap = Collections.singletonMap("roles", roles);
+        Map<String, Object> customClaimMap = Collections.singletonMap(SurenessConstant.ROLES, roles);
         return issueJwtAll(id, subject, issuer, period, null, null,
                 null, null, customClaimMap);
     }
@@ -99,9 +99,9 @@ public class JsonWebTokenUtil {
                                   String audience, String payload, Long notBefore, List<String> roles,
                                   Map<String, Object> headerMap, Map<String, Object> customClaimMap){
         if (customClaimMap == null) {
-            customClaimMap = Collections.singletonMap("roles", roles);
+            customClaimMap = Collections.singletonMap(SurenessConstant.ROLES, roles);
         } else {
-            customClaimMap.put("roles", roles);
+            customClaimMap.put(SurenessConstant.ROLES, roles);
         }
         return issueJwtAll(id, subject, issuer, period, audience, payload, notBefore, headerMap, customClaimMap);
     }
@@ -119,9 +119,9 @@ public class JsonWebTokenUtil {
     public static String issueJwt(String id, String subject, String issuer, Long period,
                                   List<String> roles, Map<String, Object> customClaimMap){
         if (customClaimMap == null) {
-            customClaimMap = Collections.singletonMap("roles", roles);
+            customClaimMap = Collections.singletonMap(SurenessConstant.ROLES, roles);
         } else {
-            customClaimMap.put("roles", roles);
+            customClaimMap.put(SurenessConstant.ROLES, roles);
         }
         return issueJwtAll(id, subject, issuer, period, null, null,
                 null, null, customClaimMap);

core/src/main/java/com/usthe/sureness/util/SurenessConstant.java

+package com.usthe.sureness.util;
+
+/**
+ * sureness public constant
+ * @author tomsun28
+ * @date 2021/4/18 16:12
+ */
+public class SurenessConstant {
+
+    /** the principal for subject,like appId, username **/
+    public static final String PRINCIPAL = "principal";
+    /** multiple principal **/
+    public static final String PRINCIPALS = "principals";
+    /** the roles user have **/
+    public static final String ROLES = "roles";
+    /** the request header auth key **/
+    public static final String AUTHORIZATION = "Authorization";
+    /** Basic auth header **/
+    public static final String BASIC = "Basic";
+    /** Digest auth header **/
+    public static final String DIGEST = "Digest ";
+    /** Bearer token auth header **/
+    public static final String BEARER = "Bearer";
+    /** Token auth key **/
+    public static final String TOKEN = "token";
+}