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
PWD_EXPIRATION_BYPASS
-
-
Constructor Summary
Constructors Constructor Description DatabaseAutomaticUserSource(UserSourceProfileKernel kernel)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRole(java.lang.String roleName, UICallback ui)
void
addUser(User user, 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.java.util.Set<UserSourceEditCapability>
getEditFlags()
Which of the editing functions are supported?java.util.Collection<java.lang.String>
getRoles()
java.util.Collection<User>
getUsers()
Retrieve all users from this profile.void
removeRole(java.lang.String roleName, UICallback ui)
void
removeUser(User user, UICallback ui)
void
renameRole(java.lang.String oldName, java.lang.String newName, UICallback ui)
void
setDatabaseId(long databaseId)
void
setPrefix(java.lang.String prefix)
void
validateTables()
-
Methods inherited from class com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile
alterPassword, getName, getUser
-
Methods inherited from class com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper
getCacheValidationTimeout, getContext, getManager, getProfileId, 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, getProfileId, shutdown, startup, validatePassword
-
-
-
-
Constructor Detail
-
DatabaseAutomaticUserSource
public DatabaseAutomaticUserSource(UserSourceProfileKernel kernel)
-
-
Method Detail
-
validateTables
public void validateTables()
-
authenticate
@Nullable 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
@Nonnull public java.util.Collection<User> getUsers() throws java.lang.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.- Throws:
java.lang.Exception
-
getRoles
@Nonnull 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
-
getEditFlags
public java.util.Set<UserSourceEditCapability> getEditFlags()
Description copied from interface:UserSourceProfile
Which of the editing functions are supported?- Specified by:
getEditFlags
in interfaceUserSourceProfile
- Overrides:
getEditFlags
in classAbstractUserSourceProfile
-
addUser
public void addUser(User user, UICallback ui) throws java.lang.Exception
- Specified by:
addUser
in interfaceUserSourceProfile
- Overrides:
addUser
in classAbstractUserSourceProfile
- Throws:
java.lang.Exception
-
alterUser
public void alterUser(User user, UICallback ui) throws java.lang.Exception
- Specified by:
alterUser
in interfaceUserSourceProfile
- Overrides:
alterUser
in classAbstractUserSourceProfile
- Throws:
java.lang.Exception
-
addRole
public void addRole(java.lang.String roleName, UICallback ui) throws java.lang.Exception
- Specified by:
addRole
in interfaceUserSourceProfile
- Overrides:
addRole
in classAbstractUserSourceProfile
- Throws:
java.lang.Exception
-
removeRole
public void removeRole(java.lang.String roleName, UICallback ui) throws java.lang.Exception
- Specified by:
removeRole
in interfaceUserSourceProfile
- Overrides:
removeRole
in classAbstractUserSourceProfile
- 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 interfaceUserSourceProfile
- Overrides:
renameRole
in classAbstractUserSourceProfile
- Throws:
java.lang.Exception
-
removeUser
public void removeUser(User user, UICallback ui) throws java.lang.Exception
- Specified by:
removeUser
in interfaceUserSourceProfile
- Overrides:
removeUser
in classAbstractUserSourceProfile
- Throws:
java.lang.Exception
-
setDatabaseId
public void setDatabaseId(long databaseId)
-
setPrefix
public void setPrefix(java.lang.String prefix)
-
-