org.h2.security.auth

类 DefaultAuthenticator

java.lang.Object

org.h2.security.auth.DefaultAuthenticator

所有已实现的接口:

Authenticator

public class DefaultAuthenticator
extends Object
implements Authenticator

Default authenticator implementation.

When client connectionInfo contains property AUTHREALM={realName} credentials (typically user id and password) are validated by CredentialsValidator configured for that realm.

When client connectionInfo doesn't contains AUTHREALM property credentials are validated internally on the database

Rights assignment can be managed through UserToRolesMapper

Default configuration has a realm H2 that validate credentials through JAAS api (appName=h2). To customize configuration set h2.authConfigFile system property to refer a valid h2auth.xml config file

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_REALMNAME

构造器概要

构造器

构造器和说明
DefaultAuthenticator() Create the Authenticator with default configurations
DefaultAuthenticator(boolean skipDefaultInitialization) Create authenticator and optionally skip the default configuration.

方法概要

限定符和类型	方法和说明
void	addRealm(String name, CredentialsValidator credentialsValidator) Add an authentication realm.
User	authenticate(AuthenticationInfo authenticationInfo, Database database) Perform user authentication.
void	configureFromUrl(URL configUrl) Configure the authenticator from a configuration file
protected static DefaultAuthenticator	getInstance()
List<UserToRolesMapper>	getUserToRolesMappers() UserToRoleMappers assign roles to authenticated users
void	init(Database database) Initializes the authenticator.
boolean	isAllowUserRegistration() If set create external users in the database if not present.
boolean	isCreateMissingRoles() When set create roles not found in the database.
boolean	isPersistUsers() If set save users externals defined during the authentication.
void	setAllowUserRegistration(boolean allowUserRegistration) If set totrue creates external users in the database if not present.
void	setCreateMissingRoles(boolean createMissingRoles) Sets the flag that define behavior in case external roles not found in the database.
void	setPersistUsers(boolean persistUsers) If set to true saves users externals defined during the authentication.
void	setUserToRolesMappers(UserToRolesMapper... userToRolesMappers)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_REALMNAME

public static final String DEFAULT_REALMNAME

另请参阅:

常量字段值

构造器详细资料

DefaultAuthenticator

public DefaultAuthenticator()

Create the Authenticator with default configurations

DefaultAuthenticator

public DefaultAuthenticator(boolean skipDefaultInitialization)

Create authenticator and optionally skip the default configuration. This option is useful when the authenticator is configured at code level

参数:

skipDefaultInitialization - if true default initialization is skipped

方法详细资料

getInstance

protected static final DefaultAuthenticator getInstance()

isPersistUsers

public boolean isPersistUsers()

If set save users externals defined during the authentication.

返回:

true if user will be persisted, otherwise returns false

setPersistUsers

public void setPersistUsers(boolean persistUsers)

If set to true saves users externals defined during the authentication.

参数:

persistUsers - true if user will be persisted, otherwise false.

isAllowUserRegistration

public boolean isAllowUserRegistration()

If set create external users in the database if not present.

返回:

true if creation external user is allowed, otherwise returns false

setAllowUserRegistration

public void setAllowUserRegistration(boolean allowUserRegistration)

If set totrue creates external users in the database if not present.

参数:

allowUserRegistration - true if creation external user is allowed, otherwise returns false

isCreateMissingRoles

public boolean isCreateMissingRoles()

When set create roles not found in the database. If not set roles not found in the database are silently skipped.

返回:

true if not found roles will be created, false roles are silently skipped.

setCreateMissingRoles

public void setCreateMissingRoles(boolean createMissingRoles)

Sets the flag that define behavior in case external roles not found in the database.

参数:

createMissingRoles - when is true not found roles are created, when is false roles are silently skipped.

addRealm

public void addRealm(String name,
                     CredentialsValidator credentialsValidator)

Add an authentication realm. Realms are case insensitive

参数:

name - realm name

credentialsValidator - credentials validator for realm

getUserToRolesMappers

public List<UserToRolesMapper> getUserToRolesMappers()

UserToRoleMappers assign roles to authenticated users

返回:

current UserToRoleMappers active

setUserToRolesMappers

public void setUserToRolesMappers(UserToRolesMapper... userToRolesMappers)

init

public void init(Database database)
          throws AuthConfigException

Initializes the authenticator. this method is skipped if skipDefaultInitialization is set Order of initialization is

1. Check h2.authConfigFile system property.
2. Use the default configuration hard coded

指定者:

init 在接口中 Authenticator

参数:

database - where authenticator is initialized

抛出:

AuthConfigException

configureFromUrl

public void configureFromUrl(URL configUrl)
                      throws AuthenticationException,
                             SAXException,
                             IOException,
                             ParserConfigurationException

Configure the authenticator from a configuration file

参数:

configUrl - URL of configuration file

抛出:

AuthenticationException - on failure

SAXException - on failure

IOException - on failure

ParserConfigurationException - on failure

authenticate

public final User authenticate(AuthenticationInfo authenticationInfo,
                               Database database)
                        throws AuthenticationException

从接口复制的说明: Authenticator

Perform user authentication.

指定者:

authenticate 在接口中 Authenticator

参数:

authenticationInfo - authentication info.

database - target database instance.

返回:

valid database user or null if user doesn't exists in the database

抛出:

AuthenticationException - on failure