Package org.cyclos.entities.access

Class Session

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.access.Session

All Implemented Interfaces:

Cloneable, ProcessableForDataTranslation, DelegatingMutableUserPrincipal, DelegatingUserPrincipal, UserPrincipal, IEntity

@Entity
public class Session
extends NetworkedEntity
implements DelegatingMutableUserPrincipal

Represents a session for a stateful access

Constructor Summary

Constructors

Constructor	Description
Session()

Method Summary

Modifier and Type	Method	Description
AccessClient	getAccessClient()
UserAccount	getAccount()
BasicUser	getBasicUser()
Channel	getChannel()
Date	getCreationDate()
UserCustomFieldValue	getCustomFieldValue()
IdentityProvider	getIdentityProvider()
MobilePhone	getMobilePhone()
Network	getNetwork()	Returns the network this entity belongs to
Pin	getPin()
String	getPrincipal()	Should return a value that can be used to identify the user.
PrincipalType	getPrincipalType()
SessionProperties	getProperties()
String	getRemoteAddress()
Long	getSessionId()
TimeInterval	getSessionTimeout()	Returns the custom timeout specified for this session if any.
String	getSessionToken()
Token	getToken()
TrustedDevice	getTrustedDevice()
BasicUser	getUser()
boolean	isConfirmationPasswordValidated()
boolean	isPendingSecondaryPassword()
void	setAccessClient(AccessClient accessClient)
void	setAccount(UserAccount account)
void	setBasicUser(BasicUser basicUser)
void	setChannel(Channel channel)
void	setConfirmationPasswordValidated(boolean confirmationPasswordValidated)
void	setCreationDate(Date creationDate)
void	setCustomFieldValue(UserCustomFieldValue customFieldValue)
void	setIdentityProvider(IdentityProvider identityProvider)
void	setMobilePhone(MobilePhone mobilePhone)
void	setPendingSecondaryPassword(boolean pendingSecondaryPassword)
void	setPin(Pin pin)
void	setPrincipalType(PrincipalType principalType)
void	setProperties(SessionProperties properties)
void	setRemoteAddress(String remoteAddress)
void	setSessionTimeout(TimeInterval sessionTimeout)
void	setSessionToken(String sessionToken)
void	setToken(Token token)
void	setTrustedDevice(TrustedDevice trustedDevice)
void	setUser(BasicUser user)

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient, toShortString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.access.DelegatingMutableUserPrincipal

initFrom

Methods inherited from interface org.cyclos.impl.access.DelegatingUserPrincipal

getDelegate

Methods inherited from interface org.cyclos.model.IEntity

matches

Constructor Detail

Session

public Session()

Method Detail

getAccessClient

public AccessClient getAccessClient()

Specified by:

getAccessClient in interface UserPrincipal

getAccount

public UserAccount getAccount()

Specified by:

getAccount in interface UserPrincipal

getBasicUser

public BasicUser getBasicUser()

Specified by:

getBasicUser in interface UserPrincipal

getChannel

public Channel getChannel()

getCreationDate

public Date getCreationDate()

getCustomFieldValue

public UserCustomFieldValue getCustomFieldValue()

Specified by:

getCustomFieldValue in interface UserPrincipal

getIdentityProvider

public IdentityProvider getIdentityProvider()

getMobilePhone

public MobilePhone getMobilePhone()

Specified by:

getMobilePhone in interface UserPrincipal

getNetwork

public Network getNetwork()

Description copied from class: NetworkedEntity

Returns the network this entity belongs to

Specified by:

getNetwork in class NetworkedEntity

getPin

public Pin getPin()

getPrincipal

public String getPrincipal()

Description copied from interface: UserPrincipal

Should return a value that can be used to identify the user. In case the value should be hidden, implementors should return null.

Specified by:

getPrincipal in interface DelegatingUserPrincipal

Specified by:

getPrincipal in interface UserPrincipal

getPrincipalType

public PrincipalType getPrincipalType()

Specified by:

getPrincipalType in interface UserPrincipal

getProperties

public SessionProperties getProperties()

getRemoteAddress

public String getRemoteAddress()

getSessionId

public Long getSessionId()

getSessionTimeout

public TimeInterval getSessionTimeout()

Returns the custom timeout specified for this session if any. Otherwise return null meaning the session timeout is that set in the corresponding channel configuration.
We return null to distinguish the case there is no custom timeout to allow the SessionTimeoutHandler and SessionHandler handle the timeouts correctly.

getSessionToken

public String getSessionToken()

getToken

public Token getToken()

Specified by:

getToken in interface UserPrincipal

getTrustedDevice

public TrustedDevice getTrustedDevice()

Specified by:

getTrustedDevice in interface UserPrincipal

getUser

public BasicUser getUser()

isConfirmationPasswordValidated

public boolean isConfirmationPasswordValidated()

isPendingSecondaryPassword

public boolean isPendingSecondaryPassword()

setAccessClient

public void setAccessClient(AccessClient accessClient)

Specified by:

setAccessClient in interface DelegatingMutableUserPrincipal

setAccount

public void setAccount(UserAccount account)

Specified by:

setAccount in interface DelegatingMutableUserPrincipal

setBasicUser

public void setBasicUser(BasicUser basicUser)

Specified by:

setBasicUser in interface DelegatingMutableUserPrincipal

setChannel

public void setChannel(Channel channel)

setConfirmationPasswordValidated

public void setConfirmationPasswordValidated(boolean confirmationPasswordValidated)

setCreationDate

public void setCreationDate(Date creationDate)

setCustomFieldValue

public void setCustomFieldValue(UserCustomFieldValue customFieldValue)

Specified by:

setCustomFieldValue in interface DelegatingMutableUserPrincipal

setIdentityProvider

public void setIdentityProvider(IdentityProvider identityProvider)

setMobilePhone

public void setMobilePhone(MobilePhone mobilePhone)

Specified by:

setMobilePhone in interface DelegatingMutableUserPrincipal

setPendingSecondaryPassword

public void setPendingSecondaryPassword(boolean pendingSecondaryPassword)

setPin

public void setPin(Pin pin)

setPrincipalType

public void setPrincipalType(PrincipalType principalType)

Specified by:

setPrincipalType in interface DelegatingMutableUserPrincipal

setProperties

public void setProperties(SessionProperties properties)

setRemoteAddress

public void setRemoteAddress(String remoteAddress)

setSessionTimeout

public void setSessionTimeout(TimeInterval sessionTimeout)

setSessionToken

public void setSessionToken(String sessionToken)

setToken

public void setToken(Token token)

Specified by:

setToken in interface DelegatingMutableUserPrincipal

setTrustedDevice

public void setTrustedDevice(TrustedDevice trustedDevice)

Specified by:

setTrustedDevice in interface DelegatingMutableUserPrincipal

setUser

public void setUser(BasicUser user)