com.helger.photon.basic.security.login

Class LoginInfo

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.login.LoginInfo

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.state.IClearable, Serializable

@NotThreadSafe
public final class LoginInfo
extends com.helger.commons.collections.attrs.MapBasedAttributeContainer
implements com.helger.commons.id.IHasID<String>

Represents the information of a single logged in user.

Author:

Philip Helger

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getID()
org.joda.time.DateTime	getLastAccessDT()
org.joda.time.DateTime	getLoginDT()
org.joda.time.DateTime	getLogoutDT()
com.helger.commons.scopes.domain.ISessionScope	getSessionScope()
IUser	getUser()
String	getUserID()
int	hashCode()
boolean	isLogout()
void	setLastAccessDTNow() Update the last access date time to the current date and time.
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.IGenericAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

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.state.IClearable

clear

Method Detail

getUser

@Nonnull
public IUser getUser()

Returns:

The user to which this login info belongs. Never null.

getSessionScope

@Nonnull
public com.helger.commons.scopes.domain.ISessionScope getSessionScope()

Returns:

The session scope to which this login info belongs. Never null.

getUserID

@Nonnull
@Nonempty
public String getUserID()

Returns:

The ID of the user to which this login info belongs. Neither null nor empty.

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

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

getLoginDT

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

Returns:

The login data and time. Never null.

getLastAccessDT

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

Returns:

The last access data and time. Never null.

setLastAccessDTNow

public void setLastAccessDTNow()

Update the last access date time to the current date and time.

getLogoutDT

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

Returns:

The date and time when the user logged out. Is null when the user is still logged in :)

isLogout

public boolean isLogout()

Returns:

true if this LoginInfo refers to an already logged out user.

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>