Top Description Fields Constructors Methods
org.h2.security.auth

public Class H2AuthConfig

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List

Describe configuration of H2 DefaultAuthenticator.

Field Summary

Modifier and TypeField and Description
private boolean
private boolean
private List<RealmConfig>
private List<UserToRolesMapperConfig>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public List<RealmConfig>

Returns:

configuration of authentication realms.
getRealms
()

Gets configuration of authentication realms.

public List<UserToRolesMapperConfig>

Returns:

configuration of the mappers external users to database roles.
getUserToRolesMappers
()

Gets configuration of the mappers external users to database roles.

public boolean

Returns:

true in case user registration is allowed, otherwise returns false.
isAllowUserRegistration
()

Allow user registration flag.

public boolean

Returns:

true if the flag is set, otherwise returns false.
isCreateMissingRoles
()

When set create roles not found in the database.

public void
setAllowUserRegistration(boolean
Allow user registration flag.
allowUserRegistration
)

public void
setCreateMissingRoles(boolean
missing roles flag.
createMissingRoles
)

When set create roles not found in the database.

public void
setRealms(List<RealmConfig>
configuration of authentication realms.
realms
)

Sets configuration of authentication realms.

public void
setUserToRolesMappers(List<UserToRolesMapperConfig>
configuration of the mappers external users to database roles.
userToRolesMappers
)

Sets configuration of the mappers external users to database roles.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

allowUserRegistrationback to summary
private boolean allowUserRegistration
createMissingRolesback to summary
private boolean createMissingRoles
realmsback to summary
private List<RealmConfig> realms
userToRolesMappersback to summary
private List<UserToRolesMapperConfig> userToRolesMappers

Constructor Detail

H2AuthConfigback to summary
public H2AuthConfig()

Method Detail

getRealmsback to summary
public List<RealmConfig> getRealms()

Gets configuration of authentication realms.

Returns:List<RealmConfig>

configuration of authentication realms.

getUserToRolesMappersback to summary
public List<UserToRolesMapperConfig> getUserToRolesMappers()

Gets configuration of the mappers external users to database roles.

Returns:List<UserToRolesMapperConfig>

configuration of the mappers external users to database roles.

isAllowUserRegistrationback to summary
public boolean isAllowUserRegistration()

Allow user registration flag. If set to true creates external users in the database if not present.

Returns:boolean

true in case user registration is allowed, otherwise returns false.

isCreateMissingRolesback to summary
public boolean isCreateMissingRoles()

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

Returns:boolean

true if the flag is set, otherwise returns false.

setAllowUserRegistrationback to summary
public void setAllowUserRegistration(boolean allowUserRegistration)
Parameters
allowUserRegistration:boolean

Allow user registration flag.

setCreateMissingRolesback to summary
public void setCreateMissingRoles(boolean createMissingRoles)

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

Parameters
createMissingRoles:boolean

missing roles flag.

setRealmsback to summary
public void setRealms(List<RealmConfig> realms)

Sets configuration of authentication realms.

Parameters
realms:List<RealmConfig>

configuration of authentication realms.

setUserToRolesMappersback to summary
public void setUserToRolesMappers(List<UserToRolesMapperConfig> userToRolesMappers)

Sets configuration of the mappers external users to database roles.

Parameters
userToRolesMappers:List<UserToRolesMapperConfig>

configuration of the mappers external users to database roles.