org.neo4j.server.security.enterprise.auth.plugin.spi

Interface AuthenticationPlugin

All Superinterfaces:

AuthProviderLifecycle

All Known Implementing Classes:

AuthenticationPlugin.Adapter, AuthenticationPlugin.CachingEnabledAdapter

public interface AuthenticationPlugin
extends AuthProviderLifecycle

An authentication provider plugin for the Neo4j enterprise security module.

If the configuration setting dbms.security.plugin.authentication_enabled is set to true, all objects that implements this interface that exists in the class path at Neo4j startup, will be loaded as services.

See Also:

AuthPlugin, AuthorizationPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthenticationPlugin.Adapter
static class	AuthenticationPlugin.CachingEnabledAdapter

Method Summary

Modifier and Type	Method and Description
AuthenticationInfo	authenticate(AuthToken authToken) Should perform authentication of the identity in the given auth token and return an AuthenticationInfo result if successful.
String	name() The name of this authentication provider.

Methods inherited from interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle

initialize, shutdown, start, stop

Method Detail

name

String name()

The name of this authentication provider.

This name, prepended with the prefix "plugin-", can be used by a client to direct an auth token directly to this authentication provider.

Returns:

the name of this authentication provider

authenticate

AuthenticationInfo authenticate(AuthToken authToken)
                         throws AuthenticationException

Should perform authentication of the identity in the given auth token and return an AuthenticationInfo result if successful. If authentication failed, either null should be returned, or an AuthenticationException should be thrown.

If authentication caching is enabled, either a CacheableAuthenticationInfo or a CustomCacheableAuthenticationInfo should be returned.

Returns:

an AuthenticationInfo object if authentication was successful, otherwise null

Throws:

AuthenticationException

See Also:

AuthToken, AuthenticationInfo, CacheableAuthenticationInfo, CustomCacheableAuthenticationInfo, AuthProviderOperations.setAuthenticationCachingEnabled(boolean)