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

Interface AuthProviderOperations

public interface AuthProviderOperations

These are the methods that the plugin can perform on Neo4j.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AuthProviderOperations.Log An interface to the security log that is used by the Neo4j security module.

Method Summary

Modifier and Type	Method and Description
Clock	clock() Returns the clock that is used by the Neo4j security module within which this auth provider plugin is running.
AuthProviderOperations.Log	log() Returns the security log that is used by the Neo4j security module within which this auth provider plugin is running.
Optional<Path>	neo4jConfigFile() Returns the path to the Neo4j configuration file if one exists.
Path	neo4jHome() Returns the path to the Neo4j home directory.
String	neo4jVersion() Returns the Neo4j version.
void	setAuthenticationCachingEnabled(boolean authenticationCachingEnabled) If set to true the authentication information returned by the plugin will be cached.
void	setAuthorizationCachingEnabled(boolean authorizationCachingEnabled) If set to true the authorization information (i.e.

Method Detail

neo4jHome

Path neo4jHome()

Returns the path to the Neo4j home directory.

Returns:

the path to the Neo4j home directory

neo4jConfigFile

Optional<Path> neo4jConfigFile()

Returns the path to the Neo4j configuration file if one exists.

Returns:

the path to the Neo4j configuration file if one exists

neo4jVersion

String neo4jVersion()

Returns the Neo4j version.

Returns:

the Neo4j version

clock

Clock clock()

Returns the clock that is used by the Neo4j security module within which this auth provider plugin is running.

Returns:

the clock that is used by the Neo4j security module

log

AuthProviderOperations.Log log()

Returns the security log that is used by the Neo4j security module within which this auth provider plugin is running.

Returns:

the security log that is used by the Neo4j security module

setAuthenticationCachingEnabled

void setAuthenticationCachingEnabled(boolean authenticationCachingEnabled)

If set to true the authentication information returned by the plugin will be cached. The expiration time of the cached information is configured by the dbms.security.auth_cache_ttl configuration setting.

Since a principal can be authenticated against cached authentication information this requires the capability of matching the credentials of an authentication token against the credentials of the authentication information returned by the plugin.

The default value is false.

Parameters:

authenticationCachingEnabled - if caching of authentication information should be enabled or not

setAuthorizationCachingEnabled

void setAuthorizationCachingEnabled(boolean authorizationCachingEnabled)

If set to true the authorization information (i.e. the list of roles for a given principal) returned by the plugin will be cached. The expiration time of the cached information is configured by the dbms.security.auth_cache_ttl configuration setting. The default value is true.

Parameters:

authorizationCachingEnabled - if caching of authorization information should be enabled or not