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

Interface AuthorizationPlugin

All Superinterfaces:

AuthProviderLifecycle

All Known Implementing Classes:

AuthorizationPlugin.Adapter

public interface AuthorizationPlugin
extends AuthProviderLifecycle

An authorization provider plugin for the Neo4j enterprise security module.

If the configuration setting 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.

NOTE: If the same object also implements AuthenticationPlugin, it will not be loaded twice.

See Also:

AuthenticationPlugin, AuthPlugin, AuthorizationExpiredException

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthorizationPlugin.Adapter
static class	AuthorizationPlugin.PrincipalAndProvider An object containing a principal and its corresponding authentication provider.

Method Summary

Modifier and Type	Method and Description
AuthorizationInfo	authorize(Collection<AuthorizationPlugin.PrincipalAndProvider> principals) Should perform authorization of the given collection of principals and their corresponding authentication providers, and return an AuthorizationInfo result that contains a collection of roles that are assigned to the given principals.
String	name() The name of this authorization 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 authorization provider.

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

Returns:

the name of this authorization provider

authorize

AuthorizationInfo authorize(Collection<AuthorizationPlugin.PrincipalAndProvider> principals)

Should perform authorization of the given collection of principals and their corresponding authentication providers, and return an AuthorizationInfo result that contains a collection of roles that are assigned to the given principals.

Parameters:

principals - a collection of principals and their corresponding authentication providers

Returns:

an AuthorizationInfo result that contains the roles that are assigned to the given principals