UserSessionData (Cyclos 4.6 Scripting API Documentation)

java.lang.Object
- org.cyclos.impl.access.AbstractSessionData
- - org.cyclos.impl.access.UserSessionData

All Implemented Interfaces:

RoleContainer, SessionData

Direct Known Subclasses:

AccessClientSessionData, DirectUserSessionData, StatefulUserSessionData, StatelessUserSessionData
```
public abstract class UserSessionData
extends AbstractSessionData
```
Session data for a logged user

Author:

luis

Field Summary
- Fields inherited from class org.cyclos.impl.access.AbstractSessionData
  requestData

Constructor Summary

Constructors
Constructor and Description

UserSessionData(RequestData requestData)

Constructors
Constructor and Description
`UserSessionData(RequestData requestData)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkConsistency()` Checks for consistency.
`protected java.lang.Long`	`doGetConfigurationId()`
`protected abstract java.lang.Long`	`doGetLoggedBasicUserId()`
`protected java.util.List<java.lang.String>`	`doGetPreferredLocales()`
`protected org.cyclos.impl.users.ProductsAccessor`	`doGetProducts()` Must be implemented to return a a valid `ProductsAccessor`
`protected boolean`	`fallbackToDefaultLocales()`
`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()`
`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`	`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
`boolean`	`isLoggedIn()` Returns whether the current session represents an 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`	`isRestrictedOperator()` Returns whether the `Role.RESTRICTED_OPERATOR` is granted
`boolean`	`isVisible(org.cyclos.impl.access.EntityCheck<BaseEntity> entityCheck, 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`	`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, getPrincipal, getPrincipalType, getProducts, getRawEntityManagerHandler, getRemoteAddress, getRequestData, getSession, isGlobalAdminInNetwork, isGuest, isManagerOf, isScript, isSystem, isUserManager, resolveNetworkId, runAsSystem

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, 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
  - 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
  - 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
    
    Specified by:
    
    isGlobalAdmin in interface RoleContainer
    
    Overrides:
    
    isGlobalAdmin in class AbstractSessionData
  - isLoggedIn
```
public boolean isLoggedIn()
```
    Description copied from interface: SessionData
    
    Returns whether the current session represents an 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
  - 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(org.cyclos.impl.access.EntityCheck<BaseEntity> entityCheck,
                         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. 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 java.lang.Long doGetConfigurationId()
```
    Specified by:
    
    doGetConfigurationId in class AbstractSessionData
  - doGetLoggedBasicUserId
```
protected abstract java.lang.Long doGetLoggedBasicUserId()
```
  - doGetPreferredLocales
```
protected java.util.List<java.lang.String> doGetPreferredLocales()
```
    Overrides:
    
    doGetPreferredLocales in class AbstractSessionData
  - doGetProducts
```
protected final org.cyclos.impl.users.ProductsAccessor doGetProducts()
```
    Description copied from class: AbstractSessionData
    
    Must be implemented to return a a valid ProductsAccessor
    
    Specified by:
    
    doGetProducts in class AbstractSessionData
  - fallbackToDefaultLocales
```
protected boolean fallbackToDefaultLocales()
```
  - getPermissions
```
protected java.util.Set<Permission> getPermissions()
```
  - getRoles
```
protected java.util.Set<Role> getRoles()
```

Class UserSessionData

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSessionData

Method Detail

checkConsistency

getAccessibleBasicGroups

getAuthenticatedUser

getChannelConfiguration

getGroup

getLoggedBasicUser

hasExpiredPassword

hasPendingAgreements

hasPermission

hasRequiredValue

isAdmin

isAdminOf

isAliasOperator

isBroker

isBrokerOf

isGlobalAdmin

isLoggedIn

isMember

isMemberOnly

isNetworkAdmin

isOperator

isRestrictedOperator

isVisible

manages

relatesTo

doGetConfigurationId

doGetLoggedBasicUserId

doGetPreferredLocales

doGetProducts

fallbackToDefaultLocales

getPermissions

getRoles