Package com.inductiveautomation.ignition.gateway.user

Class AbstractUserSourceProfile

java.lang.Object

com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

All Implemented Interfaces:

UserSourceProfile, UserSourceProfileKernel

Direct Known Subclasses:

ActiveDirectoryUserSource, DatabaseAutomaticUserSource, DatabaseExpertUserSource, InternalUserSource

public abstract class AbstractUserSourceProfile
extends UserSourceProfileKernelWrapper
implements UserSourceProfile

Field Summary

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

PWD_EXPIRATION_BYPASS

Constructor Summary

Constructors

Constructor	Description
AbstractUserSourceProfile(UserSourceProfileKernel kernel)

Method Summary

Modifier and Type	Method	Description
void	addRole(java.lang.String groupName, 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)
java.util.Set<UserSourceEditCapability>	getEditFlags()	Which of the editing functions are supported?
java.lang.String	getName()	The name of this user profile.
java.util.Optional<User>	getUser(java.lang.String userName)	Fetch a User with the given user name.
void	removeRole(java.lang.String groupName, UICallback ui)
void	removeUser(User user, UICallback ui)
void	renameRole(java.lang.String oldName, java.lang.String newName, UICallback ui)

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

authenticate, getCacheValidationTimeout, getProfileId, getRoles, getUsers, shutdown, startup, validatePassword

Constructor Detail

AbstractUserSourceProfile

public AbstractUserSourceProfile(UserSourceProfileKernel kernel)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: UserSourceProfile

The name of this user profile.

Specified by:

getName in interface UserSourceProfile

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

addRole

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

Specified by:

addRole in interface UserSourceProfile

Throws:

java.lang.Exception

removeRole

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

Specified by:

removeRole in interface UserSourceProfile

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

Throws:

java.lang.Exception

addUser

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

Specified by:

addUser in interface UserSourceProfile

Throws:

java.lang.Exception

alterUser

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

Specified by:

alterUser in interface UserSourceProfile

Throws:

java.lang.Exception

removeUser

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

Specified by:

removeUser in interface UserSourceProfile

Throws:

java.lang.Exception

alterPassword

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

Specified by:

alterPassword in interface UserSourceProfile

Throws:

java.lang.Exception

getUser

@Nonnull
public java.util.Optional<User> getUser(java.lang.String userName)
                                 throws java.lang.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.

Specified by:

getUser in interface UserSourceProfile

Parameters:

userName - the user name of the User to fetch

Returns:

an Optional User with the given user name

Throws:

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