Support any principal type for notifyContainerAboutLogin() and getCallerPrincipal().

wmhopkins · wmhopkins · commit 9aa0f7a95f61 · 2017-07-09T19:47:05.000-04:00
diff --git a/src/main/java/javax/security/enterprise/authentication/mechanism/http/HttpAuthenticationMechanism.java b/src/main/java/javax/security/enterprise/authentication/mechanism/http/HttpAuthenticationMechanism.java
@@ -66,7 +66,7 @@
  * 
  * <p>
  * Implementations of this class can notify the Servlet container about a succesful authentication by using the
- * {@link HttpMessageContext#notifyContainerAboutLogin(javax.security.enterprise.CallerPrincipal, java.util.Set)} method.
+ * {@link HttpMessageContext#notifyContainerAboutLogin(java.security.Principal, java.util.Set)} method.
  * 
  * <p>
  * Implementations are expected and encouraged to delegate the actual credential validation and/or retrieval of the
diff --git a/src/main/java/javax/security/enterprise/authentication/mechanism/http/HttpMessageContext.java b/src/main/java/javax/security/enterprise/authentication/mechanism/http/HttpMessageContext.java
@@ -39,6 +39,7 @@
  */
 package javax.security.enterprise.authentication.mechanism.http;
 
+import java.security.Principal;
 import java.util.Set;
 
 import javax.security.auth.Subject;
@@ -268,12 +269,12 @@ public interface HttpMessageContext {
      * As a convenience this method returns SUCCESS, so this method can be used in
      * one fluent return statement from an {@link HttpAuthenticationMechanism}
      * 
-     * @param callerPrincipal the CallerPrincipal that will become the caller principal
+     * @param principal the Principal that will become the caller principal
      * @param groups the groups associated with the caller principal
      * @return {@link AuthenticationStatus#SUCCESS}
      *
      */
-    AuthenticationStatus notifyContainerAboutLogin(CallerPrincipal callerPrincipal, Set<String> groups);
+    AuthenticationStatus notifyContainerAboutLogin(Principal principal, Set<String> groups);
     
     /**
      * Convenience method intended to pass the <code>CredentialValidationResult</code> result of an 
@@ -283,7 +284,7 @@ public interface HttpMessageContext {
      * If the outcome from the given {@link CredentialValidationResult#getStatus()} equals
      * {@link Status#VALID}, the {@link CallerPrincipal} and groups are obtained from the
      * <code>CredentialValidationResult</code> and passed into 
-     * {@link HttpMessageContext#notifyContainerAboutLogin(CallerPrincipal, Set)}.
+     * {@link HttpMessageContext#notifyContainerAboutLogin(Principal, Set)}.
      * 
      * <p>
      * If the outcome from the given {@link CredentialValidationResult#getStatus()} is not 
@@ -313,8 +314,18 @@ public interface HttpMessageContext {
      */
     AuthenticationStatus doNothing();
     
-    CallerPrincipal getCallerPrincipal();
+    /**
+     * Gets the Principal set by a call to notifyContainerAboutLogin().
+     * 
+     * @return The caller principal
+     */
+    Principal getCallerPrincipal();
 
+    /**
+     * Gets the groups set by a call to notifyContainerAboutLogin().
+     * 
+     * @return The groups
+     */
     Set<String> getGroups();
 
 }
diff --git a/src/main/java/javax/security/enterprise/authentication/mechanism/http/HttpMessageContextWrapper.java b/src/main/java/javax/security/enterprise/authentication/mechanism/http/HttpMessageContextWrapper.java
@@ -39,13 +39,13 @@
  */
 package javax.security.enterprise.authentication.mechanism.http;
 
+import java.security.Principal;
 import java.util.Set;
 
 import javax.security.auth.Subject;
 import javax.security.auth.callback.CallbackHandler;
 import javax.security.auth.message.MessageInfo;
 import javax.security.enterprise.AuthenticationStatus;
-import javax.security.enterprise.CallerPrincipal;
 import javax.security.enterprise.identitystore.CredentialValidationResult;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
@@ -166,8 +166,8 @@ public AuthenticationStatus notifyContainerAboutLogin(String username, Set<Strin
     }
 
     @Override
-    public AuthenticationStatus notifyContainerAboutLogin(CallerPrincipal callerPrincipal, Set<String> roles) {
-        return getWrapped().notifyContainerAboutLogin(callerPrincipal, roles);
+    public AuthenticationStatus notifyContainerAboutLogin(Principal principal, Set<String> roles) {
+        return getWrapped().notifyContainerAboutLogin(principal, roles);
     }
 
     @Override
@@ -181,7 +181,7 @@ public AuthenticationStatus doNothing() {
     }
 
     @Override
-    public CallerPrincipal getCallerPrincipal() {
+    public Principal getCallerPrincipal() {
         return getWrapped().getCallerPrincipal();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@`
`66`	`66`	`*`
`67`	`67`	`* <p>`
`68`	`68`	`* Implementations of this class can notify the Servlet container about a succesful authentication by using the`
`69`		`- * {@link HttpMessageContext#notifyContainerAboutLogin(javax.security.enterprise.CallerPrincipal, java.util.Set)} method.`
	`69`	`+ * {@link HttpMessageContext#notifyContainerAboutLogin(java.security.Principal, java.util.Set)} method.`
`70`	`70`	`*`
`71`	`71`	`* <p>`
`72`	`72`	`* Implementations are expected and encouraged to delegate the actual credential validation and/or retrieval of the`