com.helger.photon.basic.security.user

Interface IUser

All Superinterfaces:

IAuthSubject, com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer<String,Object>, com.helger.datetime.IHasCreationDateTime, com.helger.datetime.IHasDeletionDateTime, com.helger.commons.name.IHasDescription, com.helger.commons.name.IHasDisplayName, com.helger.commons.id.IHasID<String>, com.helger.datetime.IHasLastModificationDateTime, com.helger.commons.name.IHasName, com.helger.commons.type.IHasType, com.helger.commons.collections.attrs.IReadonlyAttributeContainer, com.helger.commons.type.ITypedObject<String>, Serializable

All Known Implementing Classes:

User

@MustImplementEqualsAndHashcode
public interface IUser
extends com.helger.commons.type.ITypedObject<String>, com.helger.commons.name.IHasDisplayName, com.helger.commons.name.IHasDescription, com.helger.datetime.IHasCreationDateTime, com.helger.datetime.IHasLastModificationDateTime, com.helger.datetime.IHasDeletionDateTime, IAuthSubject, com.helger.commons.collections.attrs.IReadonlyAttributeContainer

Interface for a single user

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
int	getConsecutiveFailedLoginCount()
Locale	getDesiredLocale()
String	getDisplayName()
String	getEmailAddress() The email address is optional since 2.6.3
String	getFirstName()
org.joda.time.DateTime	getLastLoginDateTime()
String	getLastName()
int	getLoginCount()
String	getLoginName()
PasswordHash	getPasswordHash()
boolean	isAdministrator()
boolean	isDeleted()
boolean	isDisabled()
boolean	isEnabled()

Methods inherited from interface com.helger.commons.type.IHasType

getTypeID

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.commons.name.IHasDescription

getDescription

Methods inherited from interface com.helger.datetime.IHasCreationDateTime

getCreationDateTime

Methods inherited from interface com.helger.datetime.IHasLastModificationDateTime

getLastModificationDateTime

Methods inherited from interface com.helger.datetime.IHasDeletionDateTime

getDeletionDateTime

Methods inherited from interface com.helger.commons.name.IHasName

getName

Methods inherited from interface com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeNames, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Method Detail

isAdministrator

boolean isAdministrator()

Returns:

true if the user has the ID CSecurity.USER_ADMINISTRATOR_ID, false otherwise

getLoginName

@Nonnull
@Nonempty
String getLoginName()

Returns:

The login name of the user.

getEmailAddress

@Nullable
String getEmailAddress()

The email address is optional since 2.6.3

Returns:

The email address of the user. May be null.

getPasswordHash

@Nonnull
PasswordHash getPasswordHash()

Returns:

The hashed password of the user. Never null.

getFirstName

@Nullable
String getFirstName()

Returns:

The first name of the user. May be null.

getLastName

@Nullable
String getLastName()

Returns:

The last name of the user. May be null.

getDisplayName

@Nonnull
String getDisplayName()

Specified by:

getDisplayName in interface com.helger.commons.name.IHasDisplayName

Returns:

The display name of the user. May be empty if both first and last name are empty but never null.

getDesiredLocale

@Nullable
Locale getDesiredLocale()

Returns:

The desired locale of the user. May be null.

getLastLoginDateTime

@Nullable
org.joda.time.DateTime getLastLoginDateTime()

Returns:

The date time when the user last logged in. May be null if the user never logged in.

Since:

2.4.2

getLoginCount

@Nonnegative
int getLoginCount()

Returns:

The number of times the user logged in. Always ≥ 0.

Since:

2.4.2

getConsecutiveFailedLoginCount

@Nonnegative
int getConsecutiveFailedLoginCount()

Returns:

The number of consecutive failed logins of this user.

Since:

2.6.3

isDeleted

boolean isDeleted()

Returns:

true if this user is deleted, false if it is active

isEnabled

boolean isEnabled()

Returns:

true if this user is enabled, false if it is disabled

See Also:

isDisabled()

isDisabled

boolean isDisabled()

Returns:

true if this user is disabled, false if it is enabled

See Also:

isEnabled()