org.cyclos.impl.access

Class UserSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

org.cyclos.impl.access.UserSessionData

All Implemented Interfaces:

SessionData

Direct Known Subclasses:

AccessClientSessionData, DirectUserSessionData, StatefulUserSessionData, StatelessUserSessionData

public abstract class UserSessionData
extends AbstractSessionData

Session data for a logged user

Author:

luis

Constructor Summary

Constructors

Constructor and Description
UserSessionData(RequestData requestData)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConsistency() Checks for consistency.
protected java.lang.Long	doGetConfigurationId()
protected abstract java.lang.Long	doGetLoggedBasicUserId()
java.util.Collection<BasicGroup>	getAccessibleBasicGroups() Returns the basic groups accessible by the current session
UserAuthVO	getAuthenticatedUser() Returns the user authentication data, or null if none
ChannelConfiguration	getChannelConfiguration() Returns the channel configuration accessor
Group	getGroup() Returns the group of the authenticated user, if any
BasicUser	getLoggedBasicUser() Returns the authenticated basic user, or null if none
protected java.util.Set<Permission>	getPermissions()
org.cyclos.impl.users.ProductsAccessor	getProducts() Returns the products accessor
RequestData	getRequestData() Returns data about the calling request.
protected java.util.Set<Role>	getRoles()
boolean	hasExpiredPassword() Returns whether the user's access password has expired
boolean	hasPendingAgreements() Returns whether the logged user has some pending agreements
boolean	hasPermission(Permission permission) Returns whether the current user has the given permission
boolean	hasRequiredValue(Permission permission, java.lang.Object value) Returns whether the current user has access to the given required value for the given permission
boolean	hasRole(Role role) Returns whether the current user has the given role
boolean	isVisible(org.cyclos.impl.access.EntityCheck<org.cyclos.entities.BaseEntity> entityCheck, org.cyclos.entities.BaseEntity 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	needsSecurityQuestion() Returns whether the user should register a security question
boolean	relatesTo(BasicUser basicUser) Returns whether the current user is related to (is allowed to view) the given user

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

bean, doGetConfigurationAccessor, getApplicationContext, getChannel, getConfiguration, getConfigurationEntity, getLoggedUser, getNetwork, getRawEntityManagerHandler, getRemoteAddress, resolveNetworkId

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.SessionData

getAccessClient, getChannelName, getPrincipalType, getToken

Constructor Detail

UserSessionData

public UserSessionData(RequestData requestData)

Method Detail

checkConsistency

public void checkConsistency()
                      throws InvalidSessionDataException

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

getAccessibleBasicGroups

public java.util.Collection<BasicGroup> getAccessibleBasicGroups()

Description copied from interface: SessionData

Returns the basic groups accessible by the current session

getAuthenticatedUser

public UserAuthVO getAuthenticatedUser()

Description copied from interface: SessionData

Returns the user authentication data, or null if none

getChannelConfiguration

public ChannelConfiguration getChannelConfiguration()

Description copied from interface: SessionData

Returns the channel configuration accessor

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

getProducts

public final org.cyclos.impl.users.ProductsAccessor getProducts()

Description copied from interface: SessionData

Returns the products accessor

getRequestData

public RequestData getRequestData()

Description copied from interface: SessionData

Returns data about the calling request. Must be accessible outside transactions.

hasExpiredPassword

public boolean hasExpiredPassword()

Returns whether the user's access password has expired

hasPendingAgreements

public boolean hasPendingAgreements()

Returns whether the logged user has some pending agreements

hasPermission

public boolean hasPermission(Permission permission)

Description copied from interface: SessionData

Returns whether the current user has the given permission

hasRequiredValue

public boolean hasRequiredValue(Permission permission,
                       java.lang.Object value)

Description copied from interface: SessionData

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

hasRole

public final boolean hasRole(Role role)

Description copied from interface: SessionData

Returns whether the current user has the given role

isVisible

public boolean isVisible(org.cyclos.impl.access.EntityCheck<org.cyclos.entities.BaseEntity> entityCheck,
                org.cyclos.entities.BaseEntity 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

needsSecurityQuestion

public boolean needsSecurityQuestion()

Returns whether the user should register a security question

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 java.lang.Long doGetConfigurationId()

Specified by:

doGetConfigurationId in class AbstractSessionData

doGetLoggedBasicUserId

protected abstract java.lang.Long doGetLoggedBasicUserId()

getPermissions

protected java.util.Set<Permission> getPermissions()

getRoles

protected java.util.Set<Role> getRoles()