com.inductiveautomation.ignition.gateway.authentication.impl

Class InternalUserSource

java.lang.Object

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

com.inductiveautomation.ignition.gateway.authentication.impl.InternalUserSource

All Implemented Interfaces:

UserSourceProfile

Direct Known Subclasses:

ADInternalHybridUserSource

public class InternalUserSource
extends AbstractUserSourceProfile

This user source stores users, groups, extended properties, and contact info inside the internal database. It is fully compliant with the user-source editing capabilities of Ignition.

Relevant persistent records:

• InternalUserRecord
• InternalRoleRecord
• InternalUserRoleMapping
• InternalUserExtraPropsRecord
• InternalContactInfoRecord

Field Summary

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

cacheValidationTimeout, context, manager, profileId, profileName

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

PWD_EXPIRATION_BYPASS

Constructor Summary

Constructors

Constructor and Description
InternalUserSource(GatewayContext context, long profileId, java.lang.String profileName, long cacheTimeout)
InternalUserSource(GatewayContext context, long profileId, java.lang.String profileName, long cacheTimeout, int pwdHistory, int pwdMinLength, int pwdComplexity, int pwdMaxAge)

Method Summary

Modifier and Type	Method and Description
void	addRole(java.lang.String newName, UICallback ui)
void	addUser(User user, UICallback ui)
void	alterPassword(User user, java.lang.String oldPassword, java.lang.String newPassword)
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.
static long	createDefaultUserSource(GatewayContext context) Creates an internal user source called "default" with user "admin"/"password" and role "Administrator".
static long	createFirstUser(GatewayContext context, java.lang.String username, java.lang.String password, boolean preEncrypted) Creates an internal user source called "default" with the supplied username and password and role "Administrator".
protected java.lang.Long	findUserInternalId(PersistenceSession session, User user)
protected java.util.List<ContactInfo>	getContactInfoForUser(PersistenceSession session, InternalUserRecord user)
java.util.Set<UserSourceEditCapability>	getEditFlags() Which of the editing functions are supported?
java.util.Collection<java.lang.String>	getRoles()
protected java.util.List<java.lang.String>	getRolesForUser(PersistenceSession session, InternalUserRecord user)
protected java.util.List<ScheduleAdjustment>	getScheduleAdjustmentsForUser(PersistenceSession session, InternalUserRecord user)
java.util.Collection<User>	getUsers() Retrieve all users from this profile.
protected void	loadExtendedUserProperties(PersistenceSession session, InternalUserRecord userRec, PropertySet user)
protected void	loadUserProperties(InternalUserRecord userRec, User user)
void	removeRole(java.lang.String group, UICallback ui)
void	removeUser(User user, UICallback ui)
void	renameRole(java.lang.String oldName, java.lang.String newName, UICallback ui)
java.lang.String	toString()
java.lang.String	validatePassword(User user, java.lang.String password) Validate the given password.

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

getCacheValidationTimeout, getName, getProfileId, shutdown, startup

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalUserSource

public InternalUserSource(GatewayContext context,
                          long profileId,
                          java.lang.String profileName,
                          long cacheTimeout)

InternalUserSource

public InternalUserSource(GatewayContext context,
                          long profileId,
                          java.lang.String profileName,
                          long cacheTimeout,
                          int pwdHistory,
                          int pwdMinLength,
                          int pwdComplexity,
                          int pwdMaxAge)

Method Detail

createDefaultUserSource

public static long createDefaultUserSource(GatewayContext context)
                                    throws java.lang.Exception

Creates an internal user source called "default" with user "admin"/"password" and role "Administrator". Returns the long id of the new profile.

Throws:

java.lang.Exception

createFirstUser

public static long createFirstUser(GatewayContext context,
                                   java.lang.String username,
                                   java.lang.String password,
                                   boolean preEncrypted)
                            throws java.lang.Exception

Creates an internal user source called "default" with the supplied username and password and role "Administrator". Returns the long id of the new profile.

Parameters:

context - The GatewayContext instance

username - The username, Must not be null

password - The password either pre-encrypted or not. Must not be null

Returns:

The profile id.

Throws:

java.lang.Exception

authenticate

public AuthenticatedUser authenticate(AuthChallenge challenge)
                               throws java.lang.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:

java.lang.Exception

getUsers

public java.util.Collection<User> getUsers()

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.

loadUserProperties

protected void loadUserProperties(InternalUserRecord userRec,
                                  User user)

getRolesForUser

protected java.util.List<java.lang.String> getRolesForUser(PersistenceSession session,
                                                           InternalUserRecord user)

getContactInfoForUser

protected java.util.List<ContactInfo> getContactInfoForUser(PersistenceSession session,
                                                            InternalUserRecord user)

getScheduleAdjustmentsForUser

protected java.util.List<ScheduleAdjustment> getScheduleAdjustmentsForUser(PersistenceSession session,
                                                                           InternalUserRecord user)

loadExtendedUserProperties

protected void loadExtendedUserProperties(PersistenceSession session,
                                          InternalUserRecord userRec,
                                          PropertySet user)

getRoles

public java.util.Collection<java.lang.String> getRoles()
                                                throws java.lang.Exception

Returns:

a collection of all possible role names for this profile. May be empty

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEditFlags

public java.util.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

validatePassword

public java.lang.String validatePassword(@Nonnull
                                         User user,
                                         java.lang.String password)

Description copied from interface: UserSourceProfile

Validate the given password. Note that this doesn't mean it checks to see if this password matches the user's current password. Rather, it means that this password would be an acceptable new password for the user.

Returns:

A i18n key for the error message describing why the password is invalid, or null if the password is valid.

addUser

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

Specified by:

addUser in interface UserSourceProfile

Overrides:

addUser in class AbstractUserSourceProfile

Throws:

java.lang.Exception

findUserInternalId

protected java.lang.Long findUserInternalId(PersistenceSession session,
                                            User user)

alterPassword

public void alterPassword(User user,
                          java.lang.String oldPassword,
                          java.lang.String newPassword)
                   throws java.lang.Exception

Specified by:

alterPassword in interface UserSourceProfile

Overrides:

alterPassword in class AbstractUserSourceProfile

Throws:

java.lang.Exception

alterUser

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

Specified by:

alterUser in interface UserSourceProfile

Overrides:

alterUser in class AbstractUserSourceProfile

Throws:

java.lang.Exception

removeUser

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

Specified by:

removeUser in interface UserSourceProfile

Overrides:

removeUser in class AbstractUserSourceProfile

Throws:

java.lang.Exception

addRole

public void addRole(java.lang.String newName,
                    UICallback ui)
             throws java.lang.Exception

Specified by:

addRole in interface UserSourceProfile

Overrides:

addRole in class AbstractUserSourceProfile

Throws:

java.lang.Exception

renameRole

public void renameRole(java.lang.String oldName,
                       java.lang.String newName,
                       UICallback ui)
                throws java.lang.Exception

Specified by:

renameRole in interface UserSourceProfile

Overrides:

renameRole in class AbstractUserSourceProfile

Throws:

java.lang.Exception

removeRole

public void removeRole(java.lang.String group,
                       UICallback ui)
                throws java.lang.Exception

Specified by:

removeRole in interface UserSourceProfile

Overrides:

removeRole in class AbstractUserSourceProfile

Throws:

java.lang.Exception