More consistent getter syntax

neo4j · Sep 27, 2016 · cbb2db6 · cbb2db6
1 parent 5a7d60f
commit cbb2db6
Show file tree

Hide file tree

Showing 18 changed files with 56 additions and 57 deletions.
diff --git a/...ty/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginApiAuthToken.java b/...ty/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginApiAuthToken.java
@@ -42,19 +42,19 @@ private PluginApiAuthToken( String principal, char[] credentials, Map<String,Obj
     }
 
     @Override
-    public String getPrincipal()
+    public String principal()
     {
         return principal;
     }
 
     @Override
-    public char[] getCredentials()
+    public char[] credentials()
     {
         return credentials;
     }
 
     @Override
-    public Map<String,Object> getParameters()
+    public Map<String,Object> parameters()
     {
         return parameters;
     }

diff --git a/...curity/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthInfo.java b/...curity/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthInfo.java
@@ -53,28 +53,28 @@ private PluginAuthInfo( Object principal, Object hashedCredentials, ByteSource c
 
     private PluginAuthInfo( AuthInfo authInfo, SimpleHash hashedCredentials, String realmName )
     {
-        this( authInfo.getPrincipal(), hashedCredentials.getBytes(), hashedCredentials.getSalt(), realmName,
-                authInfo.getRoles().stream().collect( Collectors.toSet() ) );
+        this( authInfo.principal(), hashedCredentials.getBytes(), hashedCredentials.getSalt(), realmName,
+                authInfo.roles().stream().collect( Collectors.toSet() ) );
     }
 
     public static PluginAuthInfo create( AuthInfo authInfo, String realmName )
     {
-        return new PluginAuthInfo( authInfo.getPrincipal(), realmName,
-                authInfo.getRoles().stream().collect( Collectors.toSet() ) );
+        return new PluginAuthInfo( authInfo.principal(), realmName,
+                authInfo.roles().stream().collect( Collectors.toSet() ) );
     }
 
     public static PluginAuthInfo createCacheable( AuthInfo authInfo, String realmName, SecureHasher secureHasher )
     {
         if ( authInfo instanceof CacheableAuthInfo )
         {
-            byte[] credentials = ((CacheableAuthInfo) authInfo).getCredentials();
+            byte[] credentials = ((CacheableAuthInfo) authInfo).credentials();
             SimpleHash hashedCredentials = secureHasher.hash( credentials );
             return new PluginAuthInfo( authInfo, hashedCredentials, realmName );
         }
         else
         {
-            return new PluginAuthInfo( authInfo.getPrincipal(), realmName,
-                    authInfo.getRoles().stream().collect( Collectors.toSet() ) );
+            return new PluginAuthInfo( authInfo.principal(), realmName,
+                    authInfo.roles().stream().collect( Collectors.toSet() ) );
         }
     }
 

diff --git a/.../main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthenticationInfo.java b/.../main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthenticationInfo.java
@@ -55,13 +55,13 @@ public CustomCacheableAuthenticationInfo.CredentialsMatcher getCredentialsMatche
 
     private static PluginAuthenticationInfo create( AuthenticationInfo authenticationInfo, String realmName )
     {
-        return new PluginAuthenticationInfo( authenticationInfo.getPrincipal(), realmName, null );
+        return new PluginAuthenticationInfo( authenticationInfo.principal(), realmName, null );
     }
 
     private static PluginAuthenticationInfo create( AuthenticationInfo authenticationInfo, SimpleHash hashedCredentials,
             String realmName )
     {
-        return new PluginAuthenticationInfo( authenticationInfo.getPrincipal(),
+        return new PluginAuthenticationInfo( authenticationInfo.principal(),
                 hashedCredentials.getBytes(), hashedCredentials.getSalt(), realmName );
     }
 
@@ -71,11 +71,11 @@ public static PluginAuthenticationInfo createCacheable( AuthenticationInfo authe
         if ( authenticationInfo instanceof CustomCacheableAuthenticationInfo )
         {
             CustomCacheableAuthenticationInfo info = (CustomCacheableAuthenticationInfo) authenticationInfo;
-            return new PluginAuthenticationInfo( authenticationInfo, realmName, info.getCredentialsMatcher() );
+            return new PluginAuthenticationInfo( authenticationInfo, realmName, info.credentialsMatcher() );
         }
         else if ( authenticationInfo instanceof CacheableAuthenticationInfo )
         {
-            byte[] credentials = ((CacheableAuthenticationInfo) authenticationInfo).getCredentials();
+            byte[] credentials = ((CacheableAuthenticationInfo) authenticationInfo).credentials();
             SimpleHash hashedCredentials = secureHasher.hash( credentials );
             return PluginAuthenticationInfo.create( authenticationInfo, hashedCredentials, realmName );
         }

diff --git a/...c/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthorizationInfo.java b/...c/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthorizationInfo.java
@@ -35,6 +35,6 @@ private PluginAuthorizationInfo( Set<String> roles )
 
     public static PluginAuthorizationInfo create( AuthorizationInfo authorizationInfo )
     {
-        return new PluginAuthorizationInfo( new LinkedHashSet<>( authorizationInfo.getRoles() ) );
+        return new PluginAuthorizationInfo( new LinkedHashSet<>( authorizationInfo.roles() ) );
     }
 }
diff --git a/...ecurity/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/api/AuthToken.java b/...ecurity/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/api/AuthToken.java
@@ -38,7 +38,7 @@ public interface AuthToken
      *
      * @return the identity to authenticate.
      */
-    String getPrincipal();
+    String principal();
 
     /**
      * Returns the credentials that verifies the identity.
@@ -50,7 +50,7 @@ public interface AuthToken
      *
      * @return the credentials that verifies the identity.
      */
-    char[] getCredentials();
+    char[] credentials();
 
     /**
      * Returns an optional custom parameter map if provided by the client.
@@ -60,5 +60,5 @@ public interface AuthToken
      *
      * @return a custom parameter map if provided by the client, otherwise <tt>null</tt>
      */
-    Map<String,Object> getParameters();
+    Map<String,Object> parameters();
 }
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
@@ -43,27 +43,27 @@ public interface AuthInfo extends Serializable
      *
      * @return a principal that uniquely identifies the authenticated subject within this realm.
      */
-    Object getPrincipal();
+    Object principal();
 
     /**
      * Should return the roles assigned to this principal.
      *
      * @return the roles assigned to this principal
      */
-    Collection<String> getRoles();
+    Collection<String> roles();
 
     static AuthInfo of( Object principal, Collection<String> roles )
     {
         return new AuthInfo()
         {
             @Override
-            public Object getPrincipal()
+            public Object principal()
             {
                 return principal;
             }
 
             @Override
-            public Collection<String> getRoles()
+            public Collection<String> roles()
             {
                 return roles;
             }

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
@@ -37,7 +37,7 @@ public interface AuthenticationInfo extends Serializable
      *
      * @return a principal that uniquely identifies the authenticated subject within this realm.
      */
-    Object getPrincipal();
+    Object principal();
 
     static AuthenticationInfo of( Object principal )
     {

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
@@ -34,7 +34,7 @@ public interface AuthorizationInfo extends Serializable
      *
      * @return the roles assigned to the principals recognized by an <tt>AuthorizationPlugin</tt>
      */
-    Collection<String> getRoles();
+    Collection<String> roles();
 
     static AuthorizationInfo of( Collection<String> roles )
     {

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
@@ -58,10 +58,10 @@ public interface CacheableAuthInfo extends AuthInfo
      *
      * @return a principal that uniquely identifies the authenticated subject within this realm
      *
-     * @see AuthToken#getPrincipal()
+     * @see AuthToken#principal()
      */
     @Override
-    Object getPrincipal();
+    Object principal();
 
     /**
      * Should return credentials that can be cached, so that successive authentication attempts could be performed
@@ -73,29 +73,29 @@ public interface CacheableAuthInfo extends AuthInfo
      *
      * @return credentials that can be cached
      *
-     * @see AuthToken#getCredentials()
+     * @see AuthToken#credentials()
      * @see AuthPlugin#authenticateAndAuthorize(AuthToken)
      */
-    byte[] getCredentials();
+    byte[] credentials();
 
     static CacheableAuthInfo of( Object principal, byte[] credentials, Collection<String> roles )
     {
         return new CacheableAuthInfo()
         {
             @Override
-            public Object getPrincipal()
+            public Object principal()
             {
                 return principal;
             }
 
             @Override
-            public byte[] getCredentials()
+            public byte[] credentials()
             {
                 return credentials;
             }
 
             @Override
-            public Collection<String> getRoles()
+            public Collection<String> roles()
             {
                 return roles;
             }

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
@@ -47,10 +47,10 @@ public interface CacheableAuthenticationInfo extends AuthenticationInfo
      *
      * @return a principal that uniquely identifies the authenticated subject within this realm
      *
-     * @see AuthToken#getPrincipal()
+     * @see AuthToken#principal()
      */
     @Override
-    Object getPrincipal();
+    Object principal();
 
     /**
      * Should return credentials that can be cached, so that successive authentication attempts could be performed
@@ -62,10 +62,10 @@ public interface CacheableAuthenticationInfo extends AuthenticationInfo
      *
      * @return credentials that can be cached
      *
-     * @see AuthToken#getCredentials()
+     * @see AuthToken#credentials()
      * @see AuthenticationPlugin#authenticate(AuthToken)
      */
-    byte[] getCredentials();
+    byte[] credentials();
 
     /**
      * Creates a new <tt>CacheableAuthenticationInfo</tt>
@@ -79,13 +79,13 @@ static CacheableAuthenticationInfo of( Object principal, byte[] credentials )
         return new CacheableAuthenticationInfo()
         {
             @Override
-            public Object getPrincipal()
+            public Object principal()
             {
                 return principal;
             }
 
             @Override
-            public byte[] getCredentials()
+            public byte[] credentials()
             {
                 return credentials;
             }

diff --git a/...g/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java b/...g/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java
@@ -31,7 +31,7 @@
  * <p>This is an alternative to <tt>CacheableAuthenticationInfo</tt> to use if you want to manage your own way of
  * hashing and matching credentials. On authentication, when a cached authentication info from a previous successful
  * authentication attempt is found for the principal within the auth token map, then <tt>doCredentialsMatch</tt>
- * of the <tt>CredentialsMatcher</tt> returned by <tt>getCredentialsMatcher</tt> will be called to determine
+ * of the <tt>CredentialsMatcher</tt> returned by <tt>credentialsMatcher</tt> will be called to determine
  * if the credentials match.
  *
  * <p>NOTE: Caching only occurs if it is explicitly enabled by the plugin.
@@ -66,20 +66,20 @@ interface CredentialsMatcher
      * @return the credentials matcher that will be used to verify the credentials of an auth token against the
      *         cached credentials in this object
      */
-    CredentialsMatcher getCredentialsMatcher();
+    CredentialsMatcher credentialsMatcher();
 
     static CustomCacheableAuthenticationInfo of( Object principal, CredentialsMatcher credentialsMatcher )
     {
         return new CustomCacheableAuthenticationInfo()
         {
             @Override
-            public Object getPrincipal()
+            public Object principal()
             {
                 return principal;
             }
 
             @Override
-            public CredentialsMatcher getCredentialsMatcher()
+            public CredentialsMatcher credentialsMatcher()
             {
                 return credentialsMatcher;
             }

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
@@ -21,7 +21,6 @@
 
 import java.util.Hashtable;
 import java.util.LinkedHashSet;
-import java.util.Map;
 import java.util.Set;
 
 import javax.naming.Context;
@@ -57,8 +56,8 @@ public AuthInfo authenticateAndAuthorize( AuthToken authToken ) throws Authentic
     {
         try
         {
-            String username = authToken.getPrincipal();
-            char[] password = authToken.getCredentials();
+            String username = authToken.principal();
+            char[] password = authToken.credentials();
 
             LdapContext ctx = authenticate( username, password );
             Set<String> roles = authorize( ctx, username );

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
@@ -38,8 +38,8 @@ public String name()
     @Override
     public AuthInfo authenticateAndAuthorize( AuthToken authToken )
     {
-        String principal = authToken.getPrincipal();
-        char[] credentials = authToken.getCredentials();
+        String principal = authToken.principal();
+        char[] credentials = authToken.credentials();
 
         if ( principal.equals( "neo4j" ) && Arrays.equals( credentials, "neo4j".toCharArray() ) )
         {

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
@@ -36,8 +36,8 @@ public String name()
     @Override
     public AuthenticationInfo authenticate( AuthToken authToken )
     {
-        String principal = authToken.getPrincipal();
-        char[] credentials = authToken.getCredentials();
+        String principal = authToken.principal();
+        char[] credentials = authToken.credentials();
 
         if ( principal.equals( "neo4j" ) && Arrays.equals( credentials, "neo4j".toCharArray() ) )
         {

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
@@ -42,8 +42,8 @@ public AuthInfo authenticateAndAuthorize( AuthToken authToken )
     {
         getAuthInfoCallCount.incrementAndGet();
 
-        String principal = authToken.getPrincipal();
-        char[] credentials = authToken.getCredentials();
+        String principal = authToken.principal();
+        char[] credentials = authToken.credentials();
 
         if ( principal.equals( "neo4j" ) && Arrays.equals( credentials, "neo4j".toCharArray() ) )
         {

diff --git a/...a/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java b/...a/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java
@@ -40,8 +40,8 @@ public AuthenticationInfo authenticate( AuthToken authToken )
     {
         getAuthenticationInfoCallCount.incrementAndGet();
 
-        String principal = authToken.getPrincipal();
-        char[] credentials = authToken.getCredentials();
+        String principal = authToken.principal();
+        char[] credentials = authToken.credentials();
 
         if ( principal.equals( "neo4j" ) && Arrays.equals( credentials, "neo4j".toCharArray() ) )
         {

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
@@ -41,8 +41,8 @@ public String name()
     @Override
     public AuthenticationInfo authenticate( AuthToken authToken )
     {
-        String principal = authToken.getPrincipal();
-        char[] credentials = authToken.getCredentials();
+        String principal = authToken.principal();
+        char[] credentials = authToken.credentials();
 
         if ( principal.equals( "neo4j" ) && Arrays.equals( credentials, "neo4j".toCharArray() ) )
         {

diff --git a/...neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java b/...neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java
@@ -41,14 +41,14 @@ public AuthenticationInfo authenticate( AuthToken authToken )
     {
         getAuthenticationInfoCallCount.incrementAndGet();
 
-        String principal = authToken.getPrincipal();
-        char[] credentials = authToken.getCredentials();
+        String principal = authToken.principal();
+        char[] credentials = authToken.credentials();
 
         if ( principal.equals( "neo4j" ) && Arrays.equals( credentials, "neo4j".toCharArray() ) )
         {
             return CustomCacheableAuthenticationInfo.of( "neo4j",
                     ( token ) -> {
-                        char[] tokenCredentials = token.getCredentials();
+                        char[] tokenCredentials = token.credentials();
                         return Arrays.equals( tokenCredentials, "neo4j".toCharArray() );
                     } );
         }