Package pl.edu.icm.unity.engine.api.authn

Class LoginSession

java.lang.Object

pl.edu.icm.unity.engine.api.authn.LoginSession

public class LoginSession
extends Object

Represents login session. Session expiration can be stored in two ways: either to expire after a certain time of inactivity is reached or when an absolute point in time is reached. The first case is the typical one. The latter is used when user's session should be preserved between browser shutdowns.

In the absolute termination time the maxInactivity time is also used, but only after the absolute expiration time has passed. This prevents killing such session when it is being used.

Author:

K. Benedyczak

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoginSession.AuthNInfo
static class	LoginSession.RememberMeInfo

Constructor Summary

Constructors

Constructor	Description
LoginSession()
LoginSession(String id, Date started, long maxInactivity, long entityId, String realm, LoginSession.RememberMeInfo rememberMeInfo, LoginSession.AuthNInfo login1stFactor, LoginSession.AuthNInfo login2ndFactor)	Constructs a session with relative expiration
LoginSession(String id, Date started, Date expires, long maxInactivity, long entityId, String realm, LoginSession.RememberMeInfo rememberMeInfo, LoginSession.AuthNInfo login1stFactor, LoginSession.AuthNInfo login2ndFactor)	Construct a session with absolute expiration.

Method Summary

Modifier and Type	Method	Description
void	addAuthenticatedIdentities(Collection<String> identity)
void	deserialize(pl.edu.icm.unity.base.token.Token token)
LoginSession.AuthNInfo	getAdditionalAuthn()
Set<String>	getAuthenticatedIdentities()
long	getEntityId()
String	getEntityLabel()
Date	getExpires()
String	getId()
Date	getLastUsed()
LoginSession.AuthNInfo	getLogin1stFactor()
AuthenticationOptionKey	getLogin1stFactorOptionId()
LoginSession.AuthNInfo	getLogin2ndFactor()
AuthenticationOptionKey	getLogin2ndFactorOptionId()
long	getMaxInactivity()
String	getOutdatedCredentialId()
String	getRealm()
LoginSession.RememberMeInfo	getRememberMeInfo()
String	getRemoteIdP()
Map<String,String>	getSessionData()
Date	getStarted()
byte[]	getTokenContents()
boolean	isExpiredAt(long timestamp)
boolean	isUsedOutdatedCredential()
void	setAdditionalAuthn(LoginSession.AuthNInfo additionalAuthn)
void	setEntityId(long entityId)
void	setEntityLabel(String entityLabel)
void	setExpires(Date expires)
void	setId(String id)
void	setLastUsed(Date lastUsed)
void	setLogin1stFactor(LoginSession.AuthNInfo login1stFactor)
void	setLogin2ndFactor(LoginSession.AuthNInfo login2ndFactor)
void	setMaxInactivity(long maxInactivity)
void	setOutdatedCredentialId(String outdatedCredentialId)
void	setRealm(String realm)
void	setRememberMeInfo(LoginSession.RememberMeInfo rememberMeInfo)
void	setRemoteIdP(String remoteIdP)
void	setSessionData(Map<String,String> sessionData)
void	setStarted(Date started)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LoginSession

public LoginSession()

LoginSession

public LoginSession(String id,
                    Date started,
                    Date expires,
                    long maxInactivity,
                    long entityId,
                    String realm,
                    LoginSession.RememberMeInfo rememberMeInfo,
                    LoginSession.AuthNInfo login1stFactor,
                    LoginSession.AuthNInfo login2ndFactor)

Construct a session with absolute expiration.

Parameters:

id -

started -

expires -

maxInactivity -

entityId -

realm -

LoginSession

public LoginSession(String id,
                    Date started,
                    long maxInactivity,
                    long entityId,
                    String realm,
                    LoginSession.RememberMeInfo rememberMeInfo,
                    LoginSession.AuthNInfo login1stFactor,
                    LoginSession.AuthNInfo login2ndFactor)

Constructs a session with relative expiration

Parameters:

id -

started -

maxInactivity -

entityId -

realm -

Method Detail

getId

public String getId()

setId

public void setId(String id)

getStarted

public Date getStarted()

setStarted

public void setStarted(Date started)

getExpires

public Date getExpires()

setExpires

public void setExpires(Date expires)

getEntityId

public long getEntityId()

setEntityId

public void setEntityId(long entityId)

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)

getSessionData

public Map<String,String> getSessionData()

setSessionData

public void setSessionData(Map<String,String> sessionData)

getLastUsed

public Date getLastUsed()

setLastUsed

public void setLastUsed(Date lastUsed)

getMaxInactivity

public long getMaxInactivity()

setMaxInactivity

public void setMaxInactivity(long maxInactivity)

getEntityLabel

public String getEntityLabel()

setEntityLabel

public void setEntityLabel(String entityLabel)

getAuthenticatedIdentities

public Set<String> getAuthenticatedIdentities()

addAuthenticatedIdentities

public void addAuthenticatedIdentities(Collection<String> identity)

getRemoteIdP

public String getRemoteIdP()

setRemoteIdP

public void setRemoteIdP(String remoteIdP)

getOutdatedCredentialId

public String getOutdatedCredentialId()

isUsedOutdatedCredential

public boolean isUsedOutdatedCredential()

setOutdatedCredentialId

public void setOutdatedCredentialId(String outdatedCredentialId)

getRememberMeInfo

public LoginSession.RememberMeInfo getRememberMeInfo()

setRememberMeInfo

public void setRememberMeInfo(LoginSession.RememberMeInfo rememberMeInfo)

getLogin1stFactor

public LoginSession.AuthNInfo getLogin1stFactor()

getLogin1stFactorOptionId

public AuthenticationOptionKey getLogin1stFactorOptionId()

setLogin1stFactor

public void setLogin1stFactor(LoginSession.AuthNInfo login1stFactor)

getLogin2ndFactor

public LoginSession.AuthNInfo getLogin2ndFactor()

getLogin2ndFactorOptionId

public AuthenticationOptionKey getLogin2ndFactorOptionId()

setLogin2ndFactor

public void setLogin2ndFactor(LoginSession.AuthNInfo login2ndFactor)

getAdditionalAuthn

public LoginSession.AuthNInfo getAdditionalAuthn()

setAdditionalAuthn

public void setAdditionalAuthn(LoginSession.AuthNInfo additionalAuthn)

isExpiredAt

public boolean isExpiredAt(long timestamp)

deserialize

public void deserialize(pl.edu.icm.unity.base.token.Token token)

getTokenContents

public byte[] getTokenContents()

toString

public String toString()

Overrides:

toString in class Object