com.helger.photon.basic.security.user

Class User

java.lang.Object

com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

com.helger.commons.collections.attrs.MapBasedAttributeContainer

com.helger.photon.basic.security.user.User

All Implemented Interfaces:

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

@NotThreadSafe
public class User
extends com.helger.commons.collections.attrs.MapBasedAttributeContainer
implements IUser

Default implementation of the IUser interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
User(String sLoginName, String sEmailAddress, PasswordHash aPasswordHash, String sFirstName, String sLastName, String sDescription, Locale aDesiredLocale, Map<String,?> aCustomAttrs, boolean bDisabled) Create a new user

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getConsecutiveFailedLoginCount()
org.joda.time.DateTime	getCreationDateTime()
org.joda.time.DateTime	getDeletionDateTime()
String	getDescription()
Locale	getDesiredLocale()
String	getDisplayName()
String	getEmailAddress() The email address is optional since 2.6.3
String	getFirstName()
String	getID()
org.joda.time.DateTime	getLastLoginDateTime()
org.joda.time.DateTime	getLastModificationDateTime()
String	getLastName()
int	getLoginCount()
String	getLoginName()
String	getName()
PasswordHash	getPasswordHash()
com.helger.commons.type.ObjectType	getTypeID()
int	hashCode()
boolean	isAdministrator()
boolean	isDeleted()
boolean	isDisabled()
boolean	isEnabled()
String	toString()

Methods inherited from class com.helger.commons.collections.attrs.MapBasedAttributeContainer

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer

clear, containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeNames, getAttributeObject, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from class java.lang.Object

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

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

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

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.state.IClearable

clear

Constructor Detail

User

public User(@Nonnull@Nonempty
    String sLoginName,
    @Nullable
    String sEmailAddress,
    @Nonnull
    PasswordHash aPasswordHash,
    @Nullable
    String sFirstName,
    @Nullable
    String sLastName,
    @Nullable
    String sDescription,
    @Nullable
    Locale aDesiredLocale,
    @Nullable
    Map<String,?> aCustomAttrs,
    boolean bDisabled)

Create a new user

Parameters:

sLoginName - Login name of the user. May neither be null nor empty.

sEmailAddress - Email address of the user. May be null.

aPasswordHash - Password hash of the user. May not be null.

sFirstName - The first name. May be null.

sLastName - The last name. May be null.

sDescription - Optional description text. May be null.

aDesiredLocale - The desired locale. May be null.

aCustomAttrs - Custom attributes. May be null.

bDisabled - true if the user is disabled

Method Detail

getTypeID

@Nonnull
public com.helger.commons.type.ObjectType getTypeID()

Specified by:

getTypeID in interface com.helger.commons.type.IHasType

isAdministrator

public boolean isAdministrator()

Specified by:

isAdministrator in interface IUser

Returns:

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

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getCreationDateTime

@Nonnull
public org.joda.time.DateTime getCreationDateTime()

Specified by:

getCreationDateTime in interface com.helger.datetime.IHasCreationDateTime

getLastModificationDateTime

@Nullable
public org.joda.time.DateTime getLastModificationDateTime()

Specified by:

getLastModificationDateTime in interface com.helger.datetime.IHasLastModificationDateTime

getDeletionDateTime

@Nullable
public org.joda.time.DateTime getDeletionDateTime()

Specified by:

getDeletionDateTime in interface com.helger.datetime.IHasDeletionDateTime

getName

@Nonnull
@Nonempty
public final String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

getLoginName

@Nonnull
@Nonempty
public String getLoginName()

Specified by:

getLoginName in interface IUser

Returns:

The login name of the user.

getEmailAddress

@Nullable
public String getEmailAddress()

Description copied from interface: IUser

The email address is optional since 2.6.3

Specified by:

getEmailAddress in interface IUser

Returns:

The email address of the user. May be null.

getPasswordHash

@Nonnull
@Nonempty
public PasswordHash getPasswordHash()

Specified by:

getPasswordHash in interface IUser

Returns:

The hashed password of the user. Never null.

getFirstName

@Nullable
public String getFirstName()

Specified by:

getFirstName in interface IUser

Returns:

The first name of the user. May be null.

getLastName

@Nullable
public String getLastName()

Specified by:

getLastName in interface IUser

Returns:

The last name of the user. May be null.

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface com.helger.commons.name.IHasDescription

getDesiredLocale

@Nullable
public Locale getDesiredLocale()

Specified by:

getDesiredLocale in interface IUser

Returns:

The desired locale of the user. May be null.

getLastLoginDateTime

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

Specified by:

getLastLoginDateTime in interface IUser

Returns:

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

getLoginCount

@Nonnegative
public int getLoginCount()

Specified by:

getLoginCount in interface IUser

Returns:

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

getConsecutiveFailedLoginCount

@Nonnegative
public int getConsecutiveFailedLoginCount()

Specified by:

getConsecutiveFailedLoginCount in interface IUser

Returns:

The number of consecutive failed logins of this user.

getDisplayName

@Nonnull
public String getDisplayName()

Specified by:

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

Specified by:

getDisplayName in interface IUser

Returns:

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

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface IUser

Returns:

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

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface IUser

Returns:

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

See Also:

IUser.isEnabled()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IUser

Returns:

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

See Also:

IUser.isDisabled()

equals

public boolean equals(Object o)

Overrides:

equals in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

toString

public String toString()

Overrides:

toString in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>