Package org.cyclos.impl.access

Class UserSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

org.cyclos.impl.access.UserSessionData

All Implemented Interfaces:

RoleContainer, DelegatingUserPrincipal, SessionData, UserPrincipal

Direct Known Subclasses:

AccessClientSessionData, DirectUserSessionData, OidcSessionData, StatefulUserSessionData, StatelessUserSessionData

public abstract class UserSessionData
extends AbstractSessionData

Session data for a logged user

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.impl.access.AbstractSessionData

AbstractSessionData.SessionDataChannelAccessAccessor

Field Summary

Fields inherited from class org.cyclos.impl.access.AbstractSessionData

requestData

Constructor Summary

Constructors

Constructor	Description
UserSessionData(RequestData requestData)

Method Summary

Modifier and Type	Method	Description
void	checkConsistency()	Checks for consistency.
protected Long	doGetConfigurationId()
protected abstract Long	doGetLoggedBasicUserId()
protected List<String>	doGetPreferredLocales()
protected ProductsAccessor	doGetProducts()	Must be implemented to return a a valid ProductsAccessor
protected SessionDataSubjectId	doGetSubjectId()
protected abstract UserPrincipal	doGetUserPrincipal()
protected boolean	doHasExpiredPassword()
protected boolean	doHasPendingAgreements(ProductsAccessor accessor)
protected boolean	doHasPendingSecondaryPassword()
protected boolean	doHasPermission(Permission permission)
protected boolean	fallbackToDefaultLocales()
AccessClient	getAccessClient()
Set<BasicGroup>	getAccessibleBasicGroups()	Returns the basic groups accessible by the current session
UserAccountType	getAccountType()
UserAuthVO	getAuthenticatedUser()	Returns the user authentication data, or null if none
BasicUser	getBasicUser()
ChannelAccessAccessor	getChannelAccessAccessor()	Returns the accessor for the access channel (i.e the original channel used to access Cyclos) access settings.
UserCustomFieldValue	getCustomFieldValue()
Group	getGroup()	Returns the group of the authenticated user, if any
BasicUser	getLoggedBasicUser()	Returns the authenticated basic user, or null if none
MobilePhone	getMobilePhone()
protected Set<Permission>	getPermissions()
String	getPrincipal()	Should return a value that can be used to identify the user.
PrincipalType	getPrincipalType()
protected Set<Role>	getRoles()
Token	getToken()
TrustedDevice	getTrustedDevice()
UserPrincipal	getUserPrincipal()
boolean	hasExpiredPassword()	Returns whether the user's access password has expired
boolean	hasExpiredSecondaryPassword()
boolean	hasPendingAgreements()	Returns whether the logged user has some pending agreements
boolean	hasPengingSecondaryPassword()	Returns whether the user has validated its secondary password (if any).
boolean	hasRequiredValue(Permission permission, Object value)	Returns whether the current user has access to the given required value for the given permission
boolean	isAdmin()	Returns whether the Role.ADMIN is granted
boolean	isAdminOf(BasicUser basicUser)	Returns whether the current user is an administrator of the given user
boolean	isAliasOperator()	Returns whether the Role.ALIAS_OPERATOR is granted
boolean	isBroker()	Returns whether the Role.BROKER is granted
boolean	isBrokerOf(BasicUser basicUser)	Returns whether the current user is a broker of the given user
boolean	isGlobalAdmin()	Returns whether the Role.GLOBAL_ADMIN is granted Returns true if the user is the "root" user.
boolean	isLoggedIn()	Returns whether the current session represents a user
boolean	isMember()	Returns whether the Role.MEMBER is granted
boolean	isMemberOnly()	Returns true if the logged user has only Role member.
boolean	isNetworkAdmin()	Returns whether the Role.NETWORK_ADMIN is granted
boolean	isOperator()	Returns whether the Role.OPERATOR is granted
boolean	isOwnerOf(BasicUser operator)	Returns whether current user is either the owner member of a given operator or as another alias operator
boolean	isRestrictedOperator()	Returns whether the Role.RESTRICTED_OPERATOR is granted
boolean	isVisible(EntityCheck<SimpleEntity> entityCheck, SimpleEntity entity)	Returns whether the given entity is visible under the given entity check
boolean	manages(BasicUser basicUser)	Returns whether the current user manages the given user.
boolean	relatesTo(BasicUser basicUser)	Returns whether the current user is related to (is allowed to view) the given user
protected ProductsAccessor	resolveProductsAccessor(ProductsHandler productsHandler)
protected boolean	returnPendingPasswords()

Methods inherited from class org.cyclos.impl.access.AbstractSessionData

bean, doGetConfigurationAccessor, getAccessChannel, getAccessToken, getApplicationContext, getChannel, getChannelConfiguration, getChannelSettingsAccessor, getConfiguration, getConfigurationEntity, getFailedActionHandler, getIdentityProvider, getLoggedOperator, getLoggedUser, getNetwork, getPin, getProducts, getRawEntityManagerHandler, getRemoteAddress, getRequestData, getSession, getSubjectId, hasPermission, isGlobalAdminInNetwork, isGuest, isManagerOf, isMultiNetworkAdminInGlobalMode, isScript, isSelf, isSystem, isTrusted, isUserManager, resolveNetworkId, runAsSystem, runAsSystem, shouldCheckRemoteAddress

Methods inherited from class java.lang.Object

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

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

getDelegate

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

getAccessChannelName, getChannelName, hasPermission, isRest

Constructor Detail

UserSessionData

public UserSessionData(RequestData requestData)

Method Detail

checkConsistency

public void checkConsistency()
                      throws InvalidSessionDataException,
                             LoginException

Description copied from interface: SessionData

Checks for consistency. Called before invoking a service method, as system

Specified by:

checkConsistency in interface SessionData

Overrides:

checkConsistency in class AbstractSessionData

Throws:

InvalidSessionDataException

LoginException

getAccessClient

public final AccessClient getAccessClient()

Specified by:

getAccessClient in interface UserPrincipal

Overrides:

getAccessClient in class AbstractSessionData

getAccessibleBasicGroups

public Set<BasicGroup> getAccessibleBasicGroups()

Description copied from interface: SessionData

Returns the basic groups accessible by the current session

getAccountType

public final UserAccountType getAccountType()

Specified by:

getAccountType in interface UserPrincipal

Overrides:

getAccountType in class AbstractSessionData

getAuthenticatedUser

public UserAuthVO getAuthenticatedUser()

Description copied from interface: SessionData

Returns the user authentication data, or null if none

getBasicUser

public final BasicUser getBasicUser()

Specified by:

getBasicUser in interface UserPrincipal

Overrides:

getBasicUser in class AbstractSessionData

getChannelAccessAccessor

public ChannelAccessAccessor getChannelAccessAccessor()

Description copied from interface: SessionData

Returns the accessor for the access channel (i.e the original channel used to access Cyclos) access settings. Always uses the user's own settings. For example, if a global administrator is switched to a network, will get his settings, from global mode.

Specified by:

getChannelAccessAccessor in interface SessionData

Overrides:

getChannelAccessAccessor in class AbstractSessionData

getCustomFieldValue

public final UserCustomFieldValue getCustomFieldValue()

Specified by:

getCustomFieldValue in interface UserPrincipal

Overrides:

getCustomFieldValue in class AbstractSessionData

getGroup

public Group getGroup()

Description copied from interface: SessionData

Returns the group of the authenticated user, if any

getLoggedBasicUser

public final BasicUser getLoggedBasicUser()

Description copied from interface: SessionData

Returns the authenticated basic user, or null if none

getMobilePhone

public final MobilePhone getMobilePhone()

Specified by:

getMobilePhone in interface UserPrincipal

Overrides:

getMobilePhone in class AbstractSessionData

getPrincipal

public final 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

Overrides:

getPrincipal in class AbstractSessionData

getPrincipalType

public final PrincipalType getPrincipalType()

Specified by:

getPrincipalType in interface UserPrincipal

Overrides:

getPrincipalType in class AbstractSessionData

getToken

public final Token getToken()

Specified by:

getToken in interface UserPrincipal

Overrides:

getToken in class AbstractSessionData

getTrustedDevice

public final TrustedDevice getTrustedDevice()

Specified by:

getTrustedDevice in interface UserPrincipal

Overrides:

getTrustedDevice in class AbstractSessionData

getUserPrincipal

public final UserPrincipal getUserPrincipal()

hasExpiredPassword

public final boolean hasExpiredPassword()

Returns whether the user's access password has expired

hasExpiredSecondaryPassword

public boolean hasExpiredSecondaryPassword()

hasPendingAgreements

public final boolean hasPendingAgreements()

Returns whether the logged user has some pending agreements

hasPengingSecondaryPassword

public final boolean hasPengingSecondaryPassword()

Returns whether the user has validated its secondary password (if any).

See Also:

hasPengingSecondaryPassword()

hasRequiredValue

public boolean hasRequiredValue(Permission permission,
                                Object value)

Description copied from interface: SessionData

Returns whether the current user has access to the given required value for the given permission

isAdmin

public boolean isAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.ADMIN is granted

Specified by:

isAdmin in interface RoleContainer

Overrides:

isAdmin in class AbstractSessionData

isAdminOf

public boolean isAdminOf(BasicUser basicUser)

Description copied from interface: SessionData

Returns whether the current user is an administrator of the given user

Specified by:

isAdminOf in interface SessionData

Overrides:

isAdminOf in class AbstractSessionData

isAliasOperator

public boolean isAliasOperator()

Description copied from interface: RoleContainer

Returns whether the Role.ALIAS_OPERATOR is granted

Specified by:

isAliasOperator in interface RoleContainer

Overrides:

isAliasOperator in class AbstractSessionData

isBroker

public boolean isBroker()

Description copied from interface: RoleContainer

Returns whether the Role.BROKER is granted

Specified by:

isBroker in interface RoleContainer

Overrides:

isBroker in class AbstractSessionData

isBrokerOf

public boolean isBrokerOf(BasicUser basicUser)

Description copied from interface: SessionData

Returns whether the current user is a broker of the given user

Specified by:

isBrokerOf in interface SessionData

Overrides:

isBrokerOf in class AbstractSessionData

isGlobalAdmin

public boolean isGlobalAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.GLOBAL_ADMIN is granted Returns true if the user is the "root" user. For multi-networks administrators it returns false

Specified by:

isGlobalAdmin in interface RoleContainer

Overrides:

isGlobalAdmin in class AbstractSessionData

See Also:

RoleContainer.isGlobalAdmin()

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: SessionData

Returns whether the current session represents a user

Specified by:

isLoggedIn in interface SessionData

Overrides:

isLoggedIn in class AbstractSessionData

isMember

public boolean isMember()

Description copied from interface: RoleContainer

Returns whether the Role.MEMBER is granted

Specified by:

isMember in interface RoleContainer

Overrides:

isMember in class AbstractSessionData

isMemberOnly

public boolean isMemberOnly()

Description copied from interface: SessionData

Returns true if the logged user has only Role member.

Specified by:

isMemberOnly in interface SessionData

Overrides:

isMemberOnly in class AbstractSessionData

isNetworkAdmin

public boolean isNetworkAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.NETWORK_ADMIN is granted

Specified by:

isNetworkAdmin in interface RoleContainer

Overrides:

isNetworkAdmin in class AbstractSessionData

isOperator

public boolean isOperator()

Description copied from interface: RoleContainer

Returns whether the Role.OPERATOR is granted

Specified by:

isOperator in interface RoleContainer

Overrides:

isOperator in class AbstractSessionData

isOwnerOf

public boolean isOwnerOf(BasicUser operator)

Description copied from interface: SessionData

Returns whether current user is either the owner member of a given operator or as another alias operator

Specified by:

isOwnerOf in interface SessionData

Overrides:

isOwnerOf in class AbstractSessionData

isRestrictedOperator

public boolean isRestrictedOperator()

Description copied from interface: RoleContainer

Returns whether the Role.RESTRICTED_OPERATOR is granted

Specified by:

isRestrictedOperator in interface RoleContainer

Overrides:

isRestrictedOperator in class AbstractSessionData

isVisible

public boolean isVisible(EntityCheck<SimpleEntity> entityCheck,
                         SimpleEntity entity)

Description copied from interface: SessionData

Returns whether the given entity is visible under the given entity check

manages

public boolean manages(BasicUser basicUser)

Description copied from interface: SessionData

Returns whether the current user manages the given user. If the logged user and the given one are the same user then it returns true.

relatesTo

public boolean relatesTo(BasicUser basicUser)

Description copied from interface: SessionData

Returns whether the current user is related to (is allowed to view) the given user

doGetConfigurationId

protected final Long doGetConfigurationId()

Specified by:

doGetConfigurationId in class AbstractSessionData

doGetLoggedBasicUserId

protected abstract Long doGetLoggedBasicUserId()

doGetPreferredLocales

protected List<String> doGetPreferredLocales()

Overrides:

doGetPreferredLocales in class AbstractSessionData

doGetProducts

protected final ProductsAccessor doGetProducts()

Description copied from class: AbstractSessionData

Must be implemented to return a a valid ProductsAccessor

Specified by:

doGetProducts in class AbstractSessionData

doGetSubjectId

protected SessionDataSubjectId doGetSubjectId()

Specified by:

doGetSubjectId in class AbstractSessionData

doGetUserPrincipal

protected abstract UserPrincipal doGetUserPrincipal()

doHasExpiredPassword

protected boolean doHasExpiredPassword()

doHasPendingAgreements

protected boolean doHasPendingAgreements(ProductsAccessor accessor)

doHasPendingSecondaryPassword

protected boolean doHasPendingSecondaryPassword()

doHasPermission

protected boolean doHasPermission(Permission permission)

Specified by:

doHasPermission in class AbstractSessionData

fallbackToDefaultLocales

protected boolean fallbackToDefaultLocales()

getPermissions

protected Set<Permission> getPermissions()

getRoles

protected Set<Role> getRoles()

resolveProductsAccessor

protected ProductsAccessor resolveProductsAccessor(ProductsHandler productsHandler)

returnPendingPasswords

protected boolean returnPendingPasswords()