From cbb2db693854b234ba8c2b9461443eea4150af6b Mon Sep 17 00:00:00 2001 From: Henrik Nyman Date: Fri, 23 Sep 2016 16:24:26 +0200 Subject: [PATCH] More consistent getter syntax --- .../enterprise/auth/plugin/PluginApiAuthToken.java | 6 +++--- .../enterprise/auth/plugin/PluginAuthInfo.java | 14 +++++++------- .../auth/plugin/PluginAuthenticationInfo.java | 8 ++++---- .../auth/plugin/PluginAuthorizationInfo.java | 2 +- .../enterprise/auth/plugin/api/AuthToken.java | 6 +++--- .../enterprise/auth/plugin/spi/AuthInfo.java | 8 ++++---- .../auth/plugin/spi/AuthenticationInfo.java | 2 +- .../auth/plugin/spi/AuthorizationInfo.java | 2 +- .../auth/plugin/spi/CacheableAuthInfo.java | 14 +++++++------- .../plugin/spi/CacheableAuthenticationInfo.java | 12 ++++++------ .../spi/CustomCacheableAuthenticationInfo.java | 8 ++++---- .../auth/plugin/LdapGroupHasUsersAuthPlugin.java | 5 ++--- .../enterprise/auth/plugin/TestAuthPlugin.java | 4 ++-- .../auth/plugin/TestAuthenticationPlugin.java | 4 ++-- .../auth/plugin/TestCacheableAuthPlugin.java | 4 ++-- .../plugin/TestCacheableAuthenticationPlugin.java | 4 ++-- .../auth/plugin/TestCombinedAuthPlugin.java | 4 ++-- .../TestCustomCacheableAuthenticationPlugin.java | 6 +++--- 18 files changed, 56 insertions(+), 57 deletions(-) diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginApiAuthToken.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginApiAuthToken.java index 9ebc8487f2520..eb9aa842e2d8f 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginApiAuthToken.java +++ b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginApiAuthToken.java @@ -42,19 +42,19 @@ private PluginApiAuthToken( String principal, char[] credentials, Map getParameters() + public Map parameters() { return parameters; } diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthInfo.java index 9b4c8525efe01..17194ba688f9b 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthInfo.java +++ b/enterprise/security/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/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthenticationInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthenticationInfo.java index e1a3a1229dd78..eb29502c6a1f0 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthenticationInfo.java +++ b/enterprise/security/src/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/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthorizationInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthorizationInfo.java index 91cbadc191822..aeb516a354c72 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthorizationInfo.java +++ b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/PluginAuthorizationInfo.java @@ -35,6 +35,6 @@ private PluginAuthorizationInfo( Set roles ) public static PluginAuthorizationInfo create( AuthorizationInfo authorizationInfo ) { - return new PluginAuthorizationInfo( new LinkedHashSet<>( authorizationInfo.getRoles() ) ); + return new PluginAuthorizationInfo( new LinkedHashSet<>( authorizationInfo.roles() ) ); } } diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/api/AuthToken.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/api/AuthToken.java index 14a1e698a1956..71f28ca3d2da9 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/api/AuthToken.java +++ b/enterprise/security/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 null */ - Map getParameters(); + Map parameters(); } diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthInfo.java index 4b749c3fa7577..b25bb5e5d5193 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthInfo.java +++ b/enterprise/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 getRoles(); + Collection roles(); static AuthInfo of( Object principal, Collection roles ) { return new AuthInfo() { @Override - public Object getPrincipal() + public Object principal() { return principal; } @Override - public Collection getRoles() + public Collection roles() { return roles; } diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationInfo.java index 4ce4f8b1ea2c6..bcb2a3adf73b8 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthenticationInfo.java +++ b/enterprise/security/src/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/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationInfo.java index 3ec1535241bc2..d1aa8854ce5e3 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/AuthorizationInfo.java +++ b/enterprise/security/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 AuthorizationPlugin */ - Collection getRoles(); + Collection roles(); static AuthorizationInfo of( Collection roles ) { diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthInfo.java index 4d83f09eba139..6c75f926ac042 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthInfo.java +++ b/enterprise/security/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 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 getRoles() + public Collection roles() { return roles; } diff --git a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthenticationInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthenticationInfo.java index 1c64ba0c0e7a3..568811edcab81 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CacheableAuthenticationInfo.java +++ b/enterprise/security/src/main/java/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 CacheableAuthenticationInfo @@ -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/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java index 0171e7bb003cb..0bf43231b5f0c 100644 --- a/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java +++ b/enterprise/security/src/main/java/org/neo4j/server/security/enterprise/auth/plugin/spi/CustomCacheableAuthenticationInfo.java @@ -31,7 +31,7 @@ *

This is an alternative to CacheableAuthenticationInfo 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 doCredentialsMatch - * of the CredentialsMatcher returned by getCredentialsMatcher will be called to determine + * of the CredentialsMatcher returned by credentialsMatcher will be called to determine * if the credentials match. * *

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/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/LdapGroupHasUsersAuthPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/LdapGroupHasUsersAuthPlugin.java index 27589bd207a93..d83c70f34aa6c 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/LdapGroupHasUsersAuthPlugin.java +++ b/enterprise/security/src/test/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 roles = authorize( ctx, username ); diff --git a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthPlugin.java index 0811ff80b644e..f048695d518bb 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthPlugin.java +++ b/enterprise/security/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/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthenticationPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthenticationPlugin.java index 5337d0d413d96..b5a6b755095e5 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestAuthenticationPlugin.java +++ b/enterprise/security/src/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/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthPlugin.java index bedae2e831256..7e552d5e5bc4d 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthPlugin.java +++ b/enterprise/security/src/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/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java index 1c3ad5b878d4f..a9d3005a0ae2f 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCacheableAuthenticationPlugin.java +++ b/enterprise/security/src/test/java/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/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCombinedAuthPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCombinedAuthPlugin.java index df425f71a4310..22a07cfa8c534 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCombinedAuthPlugin.java +++ b/enterprise/security/src/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/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java b/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java index f08273996b551..1fbec9f4658e7 100644 --- a/enterprise/security/src/test/java/org/neo4j/server/security/enterprise/auth/plugin/TestCustomCacheableAuthenticationPlugin.java +++ b/enterprise/security/src/test/java/org/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() ); } ); }