Rename main plugin methods to clarify concepts

- getAuthenticationInfo -> authenticate - getAuthorizationInfo -> authorize - getAuthInfo -> authenticateAndAuthorize
neo4j · Sep 16, 2016 · bd13995 · bd13995
1 parent 6d4b69a
commit bd13995
Show file tree

Hide file tree

Showing 18 changed files with 26 additions and 61 deletions.
diff --git a/.../security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginRealm.java b/.../security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginRealm.java
@@ -145,7 +145,7 @@ protected AuthorizationInfo doGetAuthorizationInfo( PrincipalCollection principa
         if ( authorizationPlugin != null )
         {
             org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationInfo authorizationInfo =
-                    authorizationPlugin.getAuthorizationInfo( getPrincipalAndRealmCollection( principals ) );
+                    authorizationPlugin.authorize( getPrincipalAndRealmCollection( principals ) );
             if ( authorizationInfo != null )
             {
                 return PluginAuthorizationInfo.create( authorizationInfo );
@@ -163,7 +163,7 @@ protected AuthenticationInfo doGetAuthenticationInfo( AuthenticationToken token
             {
                 if ( authPlugin != null )
                 {
-                    AuthInfo authInfo = authPlugin.getAuthInfo( ((ShiroAuthToken) token).getAuthTokenMap() );
+                    AuthInfo authInfo = authPlugin.authenticateAndAuthorize( ((ShiroAuthToken) token).getAuthTokenMap() );
                     if ( authInfo != null )
                     {
                         PluginAuthInfo pluginAuthInfo =
@@ -177,7 +177,7 @@ protected AuthenticationInfo doGetAuthenticationInfo( AuthenticationToken token
                 else if ( authenticationPlugin != null )
                 {
                     org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationInfo authenticationInfo =
-                            authenticationPlugin.getAuthenticationInfo( ((ShiroAuthToken) token).getAuthTokenMap() );
+                            authenticationPlugin.authenticate( ((ShiroAuthToken) token).getAuthTokenMap() );
                     if ( authenticationInfo != null )
                     {
                         return PluginAuthenticationInfo.createCacheable( authenticationInfo, getName(), secureHasher );

diff --git a/...security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthInfo.java b/...security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthInfo.java
@@ -30,7 +30,7 @@
  *
  * <p>NOTE: If authentication caching is enabled the result type <tt>CacheableAuthInfo</tt> should be used instead.
  *
- * @see AuthPlugin#getAuthInfo(Map)
+ * @see AuthPlugin#authenticateAndAuthorize(Map)
  * @see CacheableAuthInfo
  */
 public interface AuthInfo extends Serializable

diff --git a/...curity/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthPlugin.java b/...curity/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthPlugin.java
@@ -37,7 +37,7 @@ public interface AuthPlugin extends RealmLifecycle
     /**
      * TODO
      */
-    AuthInfo getAuthInfo( Map<String,Object> authToken ) throws AuthenticationException;
+    AuthInfo authenticateAndAuthorize( Map<String,Object> authToken ) throws AuthenticationException;
 
     abstract class Adapter implements AuthPlugin
     {

diff --git a/...rc/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationInfo.java b/...rc/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationInfo.java
@@ -25,7 +25,7 @@
 /**
  * An object that can be returned as the result of successful authentication by an <tt>AuthenticationPlugin</tt>.
  *
- * @see AuthenticationPlugin#getAuthenticationInfo(Map)
+ * @see AuthenticationPlugin#authenticate(Map)
  */
 public interface AuthenticationInfo extends Serializable
 {

diff --git a/.../main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationPlugin.java b/.../main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationPlugin.java
@@ -36,7 +36,7 @@ public interface AuthenticationPlugin extends RealmLifecycle
     /**
      * TODO
      */
-    AuthenticationInfo getAuthenticationInfo( Map<String,Object> authToken );
+    AuthenticationInfo authenticate( Map<String,Object> authToken );
 
     abstract class Adapter implements AuthenticationPlugin
     {

diff --git a/...src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationInfo.java b/...src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationInfo.java
@@ -25,7 +25,7 @@
 /**
  * An object that can be returned as the result of authorization by an <tt>AuthorizationPlugin</tt>.
  *
- * @see AuthorizationPlugin#getAuthorizationInfo(Collection)
+ * @see AuthorizationPlugin#authorize(Collection)
  */
 public interface AuthorizationInfo extends Serializable
 {

diff --git a/...c/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationPlugin.java b/...c/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationPlugin.java
@@ -58,7 +58,7 @@ public String realm()
     /**
      * TODO
      */
-    AuthorizationInfo getAuthorizationInfo( Collection<PrincipalAndRealm> principals );
+    AuthorizationInfo authorize( Collection<PrincipalAndRealm> principals );
 
     class Adapter implements AuthorizationPlugin
     {
@@ -70,7 +70,7 @@ public String name()
         }
 
         @Override
-        public AuthorizationInfo getAuthorizationInfo( Collection<PrincipalAndRealm> principals )
+        public AuthorizationInfo authorize( Collection<PrincipalAndRealm> principals )
         {
             return null;
         }

diff --git a/...src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthInfo.java b/...src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthInfo.java
@@ -40,7 +40,7 @@
  * <p>NOTE: Caching of the authorization info (assigned roles) does not require the use of a <tt>CacheableAuthInfo</tt>
  * but will work fine with a regular <tt>AuthInfo</tt>.
  *
- * @see AuthPlugin#getAuthInfo(Map)
+ * @see AuthPlugin#authenticateAndAuthorize(Map)
  * @see org.neo4j.server.security.enterprise.auth.plugin.api.RealmOperations#setAuthenticationCachingEnabled(boolean)
  * @see AuthInfo
  * @see AuthenticationPlugin
@@ -73,7 +73,7 @@ public interface CacheableAuthInfo extends AuthInfo
      * @return credentials that can be cached
      *
      * @see org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken#CREDENTIALS
-     * @see AuthPlugin#getAuthInfo(Map)
+     * @see AuthPlugin#authenticateAndAuthorize(Map)
      */
     byte[] getCredentials();
 

diff --git a/...ava/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthenticationInfo.java b/...ava/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthenticationInfo.java
@@ -33,7 +33,7 @@
  *
  * <p>NOTE: Caching only occurs if it is explicitly enabled by the plugin.
  *
- * @see AuthenticationPlugin#getAuthenticationInfo(Map)
+ * @see AuthenticationPlugin#authenticate(Map)
  * @see org.neo4j.server.security.enterprise.auth.plugin.api.RealmOperations#setAuthenticationCachingEnabled(boolean)
  * @see CustomCacheableAuthenticationInfo
  */
@@ -63,7 +63,7 @@ public interface CacheableAuthenticationInfo extends AuthenticationInfo
      * @return credentials that can be cached
      *
      * @see org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken#CREDENTIALS
-     * @see AuthenticationPlugin#getAuthenticationInfo(Map)
+     * @see AuthenticationPlugin#authenticate(Map)
      */
     byte[] getCredentials();
 

diff --git a/...g/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java b/...g/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java
@@ -35,7 +35,7 @@
  *
  * <p>NOTE: Caching only occurs if it is explicitly enabled by the plugin.
  *
- * @see AuthenticationPlugin#getAuthenticationInfo(Map)
+ * @see AuthenticationPlugin#authenticate(Map)
  * @see org.neo4j.server.security.enterprise.auth.plugin.api.RealmOperations#setAuthenticationCachingEnabled(boolean)
  * @see CacheableAuthenticationInfo
  */

diff --git a/...st/java/org/neo4j/server/security/enterprise/auth/plugin/LdapGroupHasUsersAuthPlugin.java b/...st/java/org/neo4j/server/security/enterprise/auth/plugin/LdapGroupHasUsersAuthPlugin.java
@@ -37,11 +37,10 @@
 import org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken;
 import org.neo4j.server.security.enterprise.auth.plugin.api.AuthenticationException;
 import org.neo4j.server.security.enterprise.auth.plugin.api.PredefinedRoles;
-import org.neo4j.server.security.enterprise.auth.plugin.api.RealmOperations;
 import org.neo4j.server.security.enterprise.auth.plugin.spi.AuthInfo;
 import org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin;
 
-public class LdapGroupHasUsersAuthPlugin implements AuthPlugin
+public class LdapGroupHasUsersAuthPlugin extends AuthPlugin.Adapter
 {
     private static final String GROUP_SEARCH_BASE = "ou=groups,dc=example,dc=com";
     private static final String GROUP_SEARCH_FILTER = "(&(objectClass=posixGroup)(memberUid={0}))";
@@ -54,7 +53,7 @@ public String name()
     }
 
     @Override
-    public AuthInfo getAuthInfo( Map<String,Object> authToken ) throws AuthenticationException
+    public AuthInfo authenticateAndAuthorize( Map<String,Object> authToken ) throws AuthenticationException
     {
         try
         {
@@ -72,26 +71,6 @@ public AuthInfo getAuthInfo( Map<String,Object> authToken ) throws Authenticatio
         }
     }
 
-    @Override
-    public void initialize( RealmOperations realmOperations ) throws Throwable
-    {
-    }
-
-    @Override
-    public void start() throws Throwable
-    {
-    }
-
-    @Override
-    public void stop() throws Throwable
-    {
-    }
-
-    @Override
-    public void shutdown() throws Throwable
-    {
-    }
-
     private LdapContext authenticate( String username, String password ) throws NamingException
     {
         Hashtable<String,Object> env = new Hashtable<>();

diff --git a/...curity/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthPlugin.java b/...curity/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthPlugin.java
@@ -19,7 +19,6 @@
  */
 package org.neo4j.server.security.enterprise.auth.plugin;
 
-import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
 
@@ -38,27 +37,14 @@ public String name()
     }
 
     @Override
-    public AuthInfo getAuthInfo( Map<String,Object> authToken )
+    public AuthInfo authenticateAndAuthorize( Map<String,Object> authToken )
     {
         String principal = (String) authToken.get( AuthToken.PRINCIPAL );
         String credentials = (String) authToken.get( AuthToken.CREDENTIALS );
 
         if ( principal.equals( "neo4j" ) && credentials.equals( "neo4j" ) )
         {
-            return new AuthInfo()
-            {
-                @Override
-                public Object getPrincipal()
-                {
-                    return "neo4j";
-                }
-
-                @Override
-                public Collection<String> getRoles()
-                {
-                    return Collections.singleton( PredefinedRoles.READER );
-                }
-            };
+            return AuthInfo.of( "neo4j", Collections.singleton( PredefinedRoles.READER ) );
         }
         return null;
     }

diff --git a/.../test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthenticationPlugin.java b/.../test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthenticationPlugin.java
@@ -34,7 +34,7 @@ public String name()
     }
 
     @Override
-    public AuthenticationInfo getAuthenticationInfo( Map<String,Object> authToken )
+    public AuthenticationInfo authenticate( Map<String,Object> authToken )
     {
         String principal = (String) authToken.get( AuthToken.PRINCIPAL );
         String credentials = (String) authToken.get( AuthToken.CREDENTIALS );

diff --git a/...c/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthorizationPlugin.java b/...c/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthorizationPlugin.java
@@ -35,7 +35,7 @@ public String name()
     }
 
     @Override
-    public AuthorizationInfo getAuthorizationInfo( Collection<PrincipalAndRealm> principals )
+    public AuthorizationInfo authorize( Collection<PrincipalAndRealm> principals )
     {
         if ( principals.stream().anyMatch( p -> "neo4j".equals( p.principal() ) ) )
         {

diff --git a/...c/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthPlugin.java b/...c/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthPlugin.java
@@ -38,7 +38,7 @@ public String name()
     }
 
     @Override
-    public AuthInfo getAuthInfo( Map<String,Object> authToken )
+    public AuthInfo authenticateAndAuthorize( Map<String,Object> authToken )
     {
         getAuthInfoCallCount.incrementAndGet();
 

diff --git a/...a/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java b/...a/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java
@@ -36,7 +36,7 @@ public String name()
     }
 
     @Override
-    public AuthenticationInfo getAuthenticationInfo( Map<String,Object> authToken )
+    public AuthenticationInfo authenticate( Map<String,Object> authToken )
     {
         getAuthenticationInfoCallCount.incrementAndGet();
 

diff --git a/...rc/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCombinedAuthPlugin.java b/...rc/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCombinedAuthPlugin.java
@@ -40,7 +40,7 @@ public String name()
     }
 
     @Override
-    public AuthenticationInfo getAuthenticationInfo( Map<String,Object> authToken )
+    public AuthenticationInfo authenticate( Map<String,Object> authToken )
     {
         String principal = (String) authToken.get( AuthToken.PRINCIPAL );
         String credentials = (String) authToken.get( AuthToken.CREDENTIALS );
@@ -53,7 +53,7 @@ public AuthenticationInfo getAuthenticationInfo( Map<String,Object> authToken )
     }
 
     @Override
-    public AuthorizationInfo getAuthorizationInfo( Collection<PrincipalAndRealm> principals )
+    public AuthorizationInfo authorize( Collection<PrincipalAndRealm> principals )
     {
         if ( principals.stream().anyMatch( p -> "neo4j".equals( p.principal() ) ) )
         {

diff --git a/...neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java b/...neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java
@@ -37,7 +37,7 @@ public String name()
     }
 
     @Override
-    public AuthenticationInfo getAuthenticationInfo( Map<String,Object> authToken )
+    public AuthenticationInfo authenticate( Map<String,Object> authToken )
     {
         getAuthenticationInfoCallCount.incrementAndGet();