com.inductiveautomation.ignition.gateway.user

Class AbstractUserSourceProfile

java.lang.Object

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

All Implemented Interfaces:

UserSourceProfile

Direct Known Subclasses:

ActiveDirectoryUserSource, DatabaseAutomaticUserSource, DatabaseExpertUserSource, InternalUserSource

public abstract class AbstractUserSourceProfile
extends java.lang.Object
implements UserSourceProfile

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cacheValidationTimeout
protected GatewayContext	context
protected UserSourceManager	manager
protected long	profileId
protected java.lang.String	profileName

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

PWD_EXPIRATION_BYPASS

Constructor Summary

Constructors

Constructor and Description
AbstractUserSourceProfile(GatewayContext context, long profileId, java.lang.String profileName, long cacheTimeout)

Method Summary

Modifier and Type	Method and 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)
long	getCacheValidationTimeout() The cache update time-out option.
java.util.Set<UserSourceEditCapability>	getEditFlags() Which of the editing functions are supported?
java.lang.String	getName() The name of this user profile.
long	getProfileId() The ID of this user profile
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)
void	shutdown() Called either when the user source has been edited and so it is being restarted, or when the gateway is shutting down.
void	startup(UserSourceManager manager) Called when the user source is created before it is used.

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, getRoles, getUsers, validatePassword

Field Detail

manager

protected UserSourceManager manager

context

protected GatewayContext context

profileId

protected long profileId

cacheValidationTimeout

protected long cacheValidationTimeout

profileName

protected java.lang.String profileName

Constructor Detail

AbstractUserSourceProfile

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

Method Detail

getProfileId

public long getProfileId()

Description copied from interface: UserSourceProfile

The ID of this user profile

Specified by:

getProfileId in interface UserSourceProfile

getCacheValidationTimeout

public long getCacheValidationTimeout()

Description copied from interface: UserSourceProfile

The cache update time-out option.

Specified by:

getCacheValidationTimeout in interface UserSourceProfile

getName

public java.lang.String getName()

Description copied from interface: UserSourceProfile

The name of this user profile.

Specified by:

getName in interface UserSourceProfile

startup

public void startup(UserSourceManager manager)

Description copied from interface: UserSourceProfile

Called when the user source is created before it is used.

Specified by:

startup in interface UserSourceProfile

shutdown

public void shutdown()

Description copied from interface: UserSourceProfile

Called either when the user source has been edited and so it is being restarted, or when the gateway is shutting down.

Specified by:

shutdown 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