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

Interface AuthPlugin

All Superinterfaces:

AuthProviderLifecycle

All Known Implementing Classes:

AuthPlugin.Adapter, AuthPlugin.CachingEnabledAdapter

public interface AuthPlugin
extends AuthProviderLifecycle

A simplified combined authentication and authorization provider plugin for the Neo4j enterprise security module.

If either the configuration setting dbms.security.plugin.authentication_enabled or dbms.security.plugin.authorization_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:

AuthenticationPlugin, AuthorizationPlugin

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
AuthInfo	authenticateAndAuthorize(AuthToken authToken) Should perform both authentication and authorization of the identity in the given auth token and return an AuthInfo result if successful.
String	name() The name of this auth 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 auth provider.

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

Returns:

the name of this auth provider

authenticateAndAuthorize

AuthInfo authenticateAndAuthorize(AuthToken authToken)
                           throws AuthenticationException

Should perform both authentication and authorization of the identity in the given auth token and return an AuthInfo result if successful. The AuthInfo result can also contain a collection of roles that are assigned to the given identity, which constitutes the authorization part. If authentication failed, either null should be returned, or an AuthenticationException should be thrown.

If authentication caching is enabled, then a CacheableAuthInfo should be returned.

Returns:

an AuthInfo object if authentication was successful, otherwise null

Throws:

AuthenticationException

See Also:

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