Package com.inductiveautomation.ignition.common.user

Class BasicAuthenticatedUser

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

com.inductiveautomation.ignition.common.user.BasicUser

com.inductiveautomation.ignition.common.user.BasicAuthenticatedUser

All Implemented Interfaces:

Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, AuthenticatedUser, User, java.io.Serializable, java.lang.Iterable<PropertyValue>

public class BasicAuthenticatedUser
extends BasicUser
implements AuthenticatedUser

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

BasicPropertySet.Builder

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.user.BasicUser

contactInfo, id, profileName, roles, scheduleAdjustments

Fields inherited from interface com.inductiveautomation.ignition.common.user.AuthenticatedUser

SecurityZones

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Fields inherited from interface com.inductiveautomation.ignition.common.user.User

Badge, DEFAULT_SCHEDULE_NAME, FirstName, Language, LastName, Notes, Password, Schedule, Username, USERNAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
BasicAuthenticatedUser(User user, java.util.Date authTimestamp)
BasicAuthenticatedUser(java.lang.String profileName, java.io.Serializable id, java.lang.String username, java.util.Collection<java.lang.String> roles)
BasicAuthenticatedUser(java.lang.String profileName, java.io.Serializable id, java.lang.String username, java.util.Collection<java.lang.String> roles, java.util.Date timestamp)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getAuthenticationTimestamp()	The date that the user was authenticated.
java.lang.String	getUsername()	All authenticated users must have a username.
BasicAuthenticatedUser	setContactInfo(java.util.List<ContactInfo> contactInfo)
BasicAuthenticatedUser	setScheduleAdjustments(java.util.List<ScheduleAdjustment> scheduleAdjustments)

Methods inherited from class com.inductiveautomation.ignition.common.user.BasicUser

equals, getContactInfo, getId, getPath, getProfileName, getRoles, getScheduleAdjustments, hashCode, setRoles

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

addPropertyChangeListener, addPropertyChangeListener, change, coerceValue, contains, firePropertyChange, get, getCount, getExtension, getOrDefault, getOrElse, getProperties, getRaw, getRawValueMap, getValues, isExtended, isInherited, iterator, of, remove, removePropertyChangeListener, removePropertyChangeListener, set, set, setDirect, setImpl, setRawValueMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable

getCount

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource

merge, remove, set, set

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource

contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues

Methods inherited from interface com.inductiveautomation.ignition.common.user.User

getContactInfo, getId, getPath, getProfileName, getRoles, getScheduleAdjustments

Constructor Detail

BasicAuthenticatedUser

public BasicAuthenticatedUser(User user,
                              java.util.Date authTimestamp)

BasicAuthenticatedUser

public BasicAuthenticatedUser(java.lang.String profileName,
                              java.io.Serializable id,
                              java.lang.String username,
                              java.util.Collection<java.lang.String> roles)

BasicAuthenticatedUser

public BasicAuthenticatedUser(java.lang.String profileName,
                              java.io.Serializable id,
                              java.lang.String username,
                              java.util.Collection<java.lang.String> roles,
                              java.util.Date timestamp)

Method Detail

setContactInfo

public BasicAuthenticatedUser setContactInfo(java.util.List<ContactInfo> contactInfo)

Overrides:

setContactInfo in class BasicUser

setScheduleAdjustments

public BasicAuthenticatedUser setScheduleAdjustments(java.util.List<ScheduleAdjustment> scheduleAdjustments)

Overrides:

setScheduleAdjustments in class BasicUser

getUsername

public java.lang.String getUsername()

Description copied from interface: AuthenticatedUser

All authenticated users must have a username.

Specified by:

getUsername in interface AuthenticatedUser

getAuthenticationTimestamp

public java.util.Date getAuthenticationTimestamp()

Description copied from interface: AuthenticatedUser

The date that the user was authenticated.

Specified by:

getAuthenticationTimestamp in interface AuthenticatedUser