Package com.inductiveautomation.ignition.gateway.authentication.impl

Class DatabaseAutomaticUserSource

java.lang.Object

com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

com.inductiveautomation.ignition.gateway.authentication.impl.DatabaseAutomaticUserSource

All Implemented Interfaces:

UserSourceProfile, UserSourceProfileKernel

public class DatabaseAutomaticUserSource
extends AbstractUserSourceProfile

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.gateway.user.UserSourceProfile

IDENTIFIER_MDC_KEY

Constructor Summary

Constructors

Constructor	Description
DatabaseAutomaticUserSource(UserSourceProfileKernel kernel)

Method Summary

Modifier and Type	Method	Description
void	addRole(Role role, UICallback ui)
void	addUser(User user, UICallback ui)
void	alterRole(Role role, UICallback ui)
void	alterUser(User user, UICallback ui)
AuthenticatedUser	authenticate(AuthChallenge challenge)	Called to both verify authentication for a given username/password pair, and to find the security roles for that user.
Set<UserSourceEditCapability>	getEditFlags()	Which of the editing functions are supported?
Collection<Role>	getRoles()
Optional<User>	getUser(String userName)	Fetch a User with the given user name.
Collection<User>	getUsers()	Retrieve all users from this profile.
void	removeRole(Role role, UICallback ui)
void	removeUser(User user, UICallback ui)
void	setDatasource(String datasource)
void	setEnableUuids(boolean enableUuids)	Set whether UUIDs are to be used for user and role IDs.
void	setPrefix(String prefix)
void	validateTables()

Methods inherited from class com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

alterPassword, getName, getRoles, getUser, getUsers

Methods inherited from class com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper

getCacheValidationTimeout, getContext, getManager, getProfileName, isLockedOut, notifyFailedAttempt, shutdown, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.user.UserSourceProfile

getCacheValidationTimeout, shutdown, startup, validatePassword

Constructor Details

DatabaseAutomaticUserSource

public DatabaseAutomaticUserSource(UserSourceProfileKernel kernel)

Method Details

validateTables

public void validateTables()

authenticate

@Nullable
public AuthenticatedUser authenticate(AuthChallenge challenge)
                               throws Exception

Description copied from interface: UserSourceProfile

Called to both verify authentication for a given username/password pair, and to find the security roles for that user.

Returns:

An AuthenticatedUser that contains the user's roles if authentication succeeded, or null if it did not.

Throws:

PasswordExpiredException - if the user's password has expired and must be reset

Exception - if there was an unexpected problem encountered during authentication

getUsers

@Nonnull
public Collection<User> getUsers()
                          throws Exception

Description copied from interface: UserSourceProfile

Retrieve all users from this profile. This can execute slowly (block) if need be. It will be called periodically by the manager and the results will be cached. Users from failover sources will be returned if hard failover is configured and triggered.

Specified by:

getUsers in interface UserSourceProfile

Specified by:

getUsers in class AbstractUserSourceProfile

Throws:

Exception

getUser

@Nonnull
public Optional<User> getUser(String userName)
                       throws Exception

Description copied from interface: UserSourceProfile

Fetch a User with the given user name. If more than one user exists with the given user name, the first user returned from the underlying data source is returned. Failover sources will be queried if hard failover is configured and the primary sources are unable to fetch the user due to an error. Failover sources will also be queried if soft failover is configured and the user is not found in the primary sources.

Specified by:

getUser in interface UserSourceProfile

Overrides:

getUser in class AbstractUserSourceProfile

Parameters:

userName - the user name of the User to fetch

Returns:

an Optional User with the given user name. the user may be from a failover user source (check User.getProfileName() to confirm)

Throws:

Exception - if there is an unexpected problem fetching the user with the given user name

See Also:

• UserSourceProfile.getUser(String, String)

getRoles

@Nonnull
public Collection<Role> getRoles()
                          throws Exception

Specified by:

getRoles in interface UserSourceProfile

Specified by:

getRoles in class AbstractUserSourceProfile

Returns:

a collection of all possible roles for this profile. May be empty. Roles from failover sources will be returned if hard failover is configured and triggered.

Throws:

Exception

getEditFlags

public Set<UserSourceEditCapability> getEditFlags()

Description copied from interface: UserSourceProfile

Which of the editing functions are supported?

Specified by:

getEditFlags in interface UserSourceProfile

Overrides:

getEditFlags in class AbstractUserSourceProfile

addUser

public void addUser(User user,
 UICallback ui)
             throws Exception

Specified by:

addUser in interface UserSourceProfile

Overrides:

addUser in class AbstractUserSourceProfile

Throws:

Exception

alterUser

public void alterUser(User user,
 UICallback ui)
               throws Exception

Specified by:

alterUser in interface UserSourceProfile

Overrides:

alterUser in class AbstractUserSourceProfile

Throws:

Exception

addRole

public void addRole(Role role,
 UICallback ui)
             throws Exception

Specified by:

addRole in interface UserSourceProfile

Overrides:

addRole in class AbstractUserSourceProfile

Throws:

Exception

removeRole

public void removeRole(Role role,
 UICallback ui)
                throws Exception

Specified by:

removeRole in interface UserSourceProfile

Overrides:

removeRole in class AbstractUserSourceProfile

Throws:

Exception

alterRole

public void alterRole(Role role,
 UICallback ui)
               throws Exception

Specified by:

alterRole in interface UserSourceProfile

Overrides:

alterRole in class AbstractUserSourceProfile

Throws:

Exception

removeUser

public void removeUser(User user,
 UICallback ui)
                throws Exception

Specified by:

removeUser in interface UserSourceProfile

Overrides:

removeUser in class AbstractUserSourceProfile

Throws:

Exception

setDatasource

public void setDatasource(String datasource)

setPrefix

public void setPrefix(String prefix)

setEnableUuids

public void setEnableUuids(boolean enableUuids)

Set whether UUIDs are to be used for user and role IDs.

Parameters:

enableUuids - True if roles and user should use UUIDs for their ID.