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

Class DatabaseExpertUserSource

java.lang.Object

com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

com.inductiveautomation.ignition.gateway.authentication.impl.DatabaseExpertUserSource

All Implemented Interfaces:

UserSourceProfile, UserSourceProfileKernel

Direct Known Subclasses:

ADtoDBHybridAuthenticator

public class DatabaseExpertUserSource
extends AbstractUserSourceProfile

This Authenticator uses a database and SQL queries to authenticate users and retrieve roles

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COL_BADGE
protected static final String	COL_FIRST_NAME
protected static final String	COL_LANGUAGE
protected static final String	COL_LAST_NAME
protected static final String	COL_NOTES
protected static final String	COL_SCHEDULE
protected static final String	COL_USER_UUID
protected static final String	COL_USERNAME

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

IDENTIFIER_MDC_KEY

Constructor Summary

Constructors

Constructor	Description
DatabaseExpertUserSource(UserSourceProfileKernel kernel)

Method Summary

Modifier and Type	Method	Description
AuthenticatedUser	authenticate(AuthChallenge challenge)	Called to both verify authentication for a given username/password pair, and to find the security roles for that user.
protected List<ContactInfo>	findContactInfo(SRConnection con, String uname)
protected PropertySet	findExtraProps(SRConnection con, String uname)
protected List<String>	findRoles(Connection con, String uname)
protected List<ScheduleAdjustment>	findScheduleAdjustment(SRConnection con, String uname)
protected SRConnection	getConnection()
Collection<Role>	getRoles()
Optional<User>	getUser(String userName)	Fetch a User with the given user name.
protected Optional<User>	getUser(String userName, SRConnection con)
Collection<User>	getUsers()	Retrieve all users from this profile.
protected Collection<User>	getUsers(SRConnection con)
protected void	set(User user, Property<String> prop, Dataset dataset, String colName)	Tries to extract information out of the dataset at row zero.
void	setAuthenticateBadgeQuery(String authenticateBadgeQuery)
void	setAuthenticateQuery(String string)
void	setDatasource(String datasource)
void	setFindUserQuery(String findUserQuery)
void	setListContactInfoQuery(String listContactInfoQuery)
void	setListExtraPropsQuery(String listExtraPropsQuery)
void	setListRolesQuery(String string)
void	setListScheduleAdjustmentsQuery(String listScheduleAdjustmentsQuery)
void	setListUserRolesQuery(String string)
void	setListUsersQuery(String listUsersQuery)
String	toString()

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

addRole, addUser, alterPassword, alterRole, alterUser, getEditFlags, getName, getRoles, getUser, getUsers, removeRole, removeUser

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, wait, wait, wait

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

getCacheValidationTimeout, shutdown, startup, validatePassword

Field Details

COL_USERNAME

protected static final String COL_USERNAME

See Also:

• Constant Field Values

COL_FIRST_NAME

protected static final String COL_FIRST_NAME

See Also:

• Constant Field Values

COL_LAST_NAME

protected static final String COL_LAST_NAME

See Also:

• Constant Field Values

COL_SCHEDULE

protected static final String COL_SCHEDULE

See Also:

• Constant Field Values

COL_LANGUAGE

protected static final String COL_LANGUAGE

See Also:

• Constant Field Values

COL_NOTES

protected static final String COL_NOTES

See Also:

• Constant Field Values

COL_BADGE

protected static final String COL_BADGE

See Also:

• Constant Field Values

COL_USER_UUID

protected static final String COL_USER_UUID

See Also:

• Constant Field Values

Constructor Details

DatabaseExpertUserSource

public DatabaseExpertUserSource(UserSourceProfileKernel kernel)

Method Details

set

protected void set(User user,
 Property<String> prop,
 Dataset dataset,
 String colName)

Tries to extract information out of the dataset at row zero. If the column doesn't exist, fails silently

authenticate

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

findRoles

@Nonnull
protected List<String> findRoles(Connection con,
 String uname)
                          throws Exception

Throws:

Exception

findContactInfo

@Nonnull
protected List<ContactInfo> findContactInfo(SRConnection con,
 String uname)

findScheduleAdjustment

protected List<ScheduleAdjustment> findScheduleAdjustment(SRConnection con,
 String uname)
                                                   throws Exception

Throws:

Exception

findExtraProps

protected PropertySet findExtraProps(SRConnection con,
 String uname)
                              throws Exception

Throws:

Exception

getUsers

@Nonnull
protected Collection<User> getUsers(SRConnection con)
                             throws Exception

Throws:

Exception

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
protected Optional<User> getUser(String userName,
 SRConnection con)
                          throws Exception

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

getConnection

protected SRConnection getConnection()
                              throws SQLException

Throws:

SQLException

setDatasource

public void setDatasource(String datasource)

setAuthenticateQuery

public void setAuthenticateQuery(String string)

setAuthenticateBadgeQuery

public void setAuthenticateBadgeQuery(String authenticateBadgeQuery)

setListRolesQuery

public void setListRolesQuery(String string)

setListUserRolesQuery

public void setListUserRolesQuery(String string)

setListExtraPropsQuery

public void setListExtraPropsQuery(String listExtraPropsQuery)

setListContactInfoQuery

public void setListContactInfoQuery(String listContactInfoQuery)

setListScheduleAdjustmentsQuery

public void setListScheduleAdjustmentsQuery(String listScheduleAdjustmentsQuery)

setFindUserQuery

public void setFindUserQuery(String findUserQuery)

setListUsersQuery

public void setListUsersQuery(String listUsersQuery)

toString

public String toString()

Overrides:

toString in class Object