A C D E I L N O P R S W

A

Adapter() - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin.Adapter

Adapter() - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin.Adapter

Adapter() - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin.Adapter

Adapter() - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle.Adapter

ADMIN - Static variable in class org.neo4j.server.security.enterprise.auth.plugin.api.PredefinedRoles

ARCHITECT - Static variable in class org.neo4j.server.security.enterprise.auth.plugin.api.PredefinedRoles

authenticate(AuthToken) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin

Should perform authentication of the identity in the given auth token and return an AuthenticationInfo result if successful.

authenticateAndAuthorize(AuthToken) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin

Should perform both authentication and authorization of the identity in the given auth token and return an AuthInfo result if successful.

AuthenticationException - Exception in org.neo4j.server.security.enterprise.auth.plugin.api

An exception that can be thrown on authentication.

AuthenticationException(String) - Constructor for exception org.neo4j.server.security.enterprise.auth.plugin.api.AuthenticationException

AuthenticationException(String, Throwable) - Constructor for exception org.neo4j.server.security.enterprise.auth.plugin.api.AuthenticationException

AuthenticationInfo - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

An object that can be returned as the result of successful authentication by an AuthenticationPlugin.

AuthenticationPlugin - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

An authentication provider plugin for the Neo4j enterprise security module.

AuthenticationPlugin.Adapter - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthenticationPlugin.CachingEnabledAdapter - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthInfo - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

An object that can be returned as the result of successful authentication by an AuthPlugin.

AuthorizationExpiredException - Exception in org.neo4j.server.security.enterprise.auth.plugin.api

An exception that can be thrown if authorization has expired and the user needs to re-authenticate in order to renew authorization.

AuthorizationExpiredException(String) - Constructor for exception org.neo4j.server.security.enterprise.auth.plugin.api.AuthorizationExpiredException

AuthorizationExpiredException(String, Throwable) - Constructor for exception org.neo4j.server.security.enterprise.auth.plugin.api.AuthorizationExpiredException

AuthorizationInfo - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

An object that can be returned as the result of authorization by an AuthorizationPlugin.

AuthorizationPlugin - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

An authorization provider plugin for the Neo4j enterprise security module.

AuthorizationPlugin.Adapter - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthorizationPlugin.PrincipalAndProvider - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

An object containing a principal and its corresponding authentication provider.

authorize(Collection<AuthorizationPlugin.PrincipalAndProvider>) - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin.Adapter

authorize(Collection<AuthorizationPlugin.PrincipalAndProvider>) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin

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.

AuthPlugin - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

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

AuthPlugin.Adapter - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthPlugin.CachingEnabledAdapter - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthProviderLifecycle - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthProviderLifecycle.Adapter - Class in org.neo4j.server.security.enterprise.auth.plugin.spi

AuthProviderOperations - Interface in org.neo4j.server.security.enterprise.auth.plugin.api

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

AuthProviderOperations.Log - Interface in org.neo4j.server.security.enterprise.auth.plugin.api

An interface to the security log that is used by the Neo4j security module.

AuthToken - Interface in org.neo4j.server.security.enterprise.auth.plugin.api

The authentication token provided by the client, which is used to authenticate the subject's identity.

C

CacheableAuthenticationInfo - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

A cacheable object that can be returned as the result of successful authentication by an AuthenticationPlugin.

CacheableAuthInfo - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

A cacheable object that can be returned as the result of successful authentication by an AuthPlugin.

CachingEnabledAdapter() - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin.CachingEnabledAdapter

CachingEnabledAdapter() - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin.CachingEnabledAdapter

clock() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

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

credentials() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken

Returns the credentials that verifies the identity.

credentials() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CacheableAuthenticationInfo

Should return credentials that can be cached, so that successive authentication attempts could be performed against the cached authentication info from a previous successful authentication attempt, without having to call AuthenticationInfo.getAuthenticationInfo() again.

credentials() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CacheableAuthInfo

Should return credentials that can be cached, so that successive authentication attempts could be performed against the cached authentication info from a previous successful authentication attempt, without having to call AuthInfo.getAuthInfo() again.

credentialsMatcher() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CustomCacheableAuthenticationInfo

Returns the credentials matcher that will be used to verify the credentials of an auth token against the cached credentials in this object.

CustomCacheableAuthenticationInfo - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

A cacheable object that can be returned as the result of successful authentication by an AuthenticationPlugin.

CustomCacheableAuthenticationInfo.CredentialsMatcher - Interface in org.neo4j.server.security.enterprise.auth.plugin.spi

D

debug(String) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations.Log

Writes to the security log at log level debug.

doCredentialsMatch(AuthToken) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CustomCacheableAuthenticationInfo.CredentialsMatcher

Returns true if the credentials of the given AuthToken matches the credentials of the cached CustomCacheableAuthenticationInfo that is the owner of this CredentialsMatcher.

E

EDITOR - Static variable in class org.neo4j.server.security.enterprise.auth.plugin.api.PredefinedRoles

error(String) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations.Log

Writes to the security log at log level error.

I

info(String) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations.Log

Writes to the security log at log level info.

initialize(AuthProviderOperations) - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin.CachingEnabledAdapter

initialize(AuthProviderOperations) - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin.CachingEnabledAdapter

initialize(AuthProviderOperations) - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle.Adapter

initialize(AuthProviderOperations) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle

isDebugEnabled() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations.Log

Returns true if log level debug is enabled.

L

log() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

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

N

name() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin.Adapter

name() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin.CachingEnabledAdapter

name() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationPlugin

The name of this authentication provider.

name() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin.Adapter

name() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin

The name of this authorization provider.

name() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin.Adapter

name() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin.CachingEnabledAdapter

name() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthPlugin

The name of this auth provider.

neo4jConfigFile() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

Deprecated.

Settings are recommended to be stored in a separate file. You can use AuthProviderOperations.neo4jHome() to resolve your configuration file, e.g. neo4jHome().resolve("conf/myPlugin.conf" );.

neo4jHome() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

Returns the path to the Neo4j home directory.

neo4jVersion() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

Returns the Neo4j version.

O

of(Object) - Static method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationInfo

of(Object, Collection<String>) - Static method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthInfo

of(Collection<String>) - Static method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationInfo

of(Object, byte[]) - Static method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CacheableAuthenticationInfo

Creates a new CacheableAuthenticationInfo

of(Object, byte[], Collection<String>) - Static method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CacheableAuthInfo

of(Object, CustomCacheableAuthenticationInfo.CredentialsMatcher) - Static method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CustomCacheableAuthenticationInfo

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

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

P

parameters() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken

Returns an optional custom parameter map if provided by the client.

PredefinedRoles - Class in org.neo4j.server.security.enterprise.auth.plugin.api

The role names of the built-in predefined roles of Neo4j.

principal() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken

Returns the identity to authenticate.

principal() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationInfo

Should return a principal that uniquely identifies the authenticated subject within this authentication provider.

principal() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthInfo

Should return a principal that uniquely identifies the authenticated subject within this auth provider.

principal() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin.PrincipalAndProvider

principal() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CacheableAuthenticationInfo

Should return a principal that uniquely identifies the authenticated subject within this authentication provider.

principal() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.CacheableAuthInfo

Should return a principal that uniquely identifies the authenticated subject within this auth provider.

PrincipalAndProvider(Object, String) - Constructor for class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin.PrincipalAndProvider

provider() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationPlugin.PrincipalAndProvider

PUBLISHER - Static variable in class org.neo4j.server.security.enterprise.auth.plugin.api.PredefinedRoles

R

READER - Static variable in class org.neo4j.server.security.enterprise.auth.plugin.api.PredefinedRoles

roles() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthInfo

Should return the roles assigned to this principal.

roles() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthorizationInfo

Should return a collection of roles assigned to the principals recognized by an AuthorizationPlugin.

S

setAuthenticationCachingEnabled(boolean) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

If set to true the authentication information returned by the plugin will be cached.

setAuthorizationCachingEnabled(boolean) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations

If set to true the authorization information (i.e.

shutdown() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle.Adapter

shutdown() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle

start() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle.Adapter

start() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle

stop() - Method in class org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle.Adapter

stop() - Method in interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthProviderLifecycle

W

warn(String) - Method in interface org.neo4j.server.security.enterprise.auth.plugin.api.AuthProviderOperations.Log

Writes to the security log at log level warning.

A C D E I L N O P R S W