SessionData (Cyclos 4.12 Scripting API Documentation)

All Superinterfaces:

RoleContainer, org.cyclos.impl.access.UserPrincipal

All Known Implementing Classes:

AbstractSessionData, AccessClientSessionData, DirectUserSessionData, GuestSessionData, ScriptSessionData, StatefulUserSessionData, StatelessUserSessionData, SystemSessionData, UserSessionData
```
public interface SessionData
extends RoleContainer, org.cyclos.impl.access.UserPrincipal
```
Contains data in a user session

Author:

luis

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`checkConsistency()` Checks for consistency.
`Channel`	`getAccessChannel()` Returns the original channel (i.e the channel used to access Cyclos) this session is using
`java.lang.String`	`getAccessChannelName()` Returns the internal name of the original channel (i.e the channel used to access Cyclos) .
`java.util.Set<BasicGroup>`	`getAccessibleBasicGroups()` Returns the basic groups accessible by the current session
`UserAuthVO`	`getAuthenticatedUser()` Returns the user authentication data, or null if none
`Channel`	`getChannel()` Returns the current channel this session is using
`org.cyclos.impl.system.ChannelAccessAccessor`	`getChannelAccessAccessor()` Returns the accessor for the access channel (i.e the original channel used to access Cyclos) access settings.
`java.lang.String`	`getChannelName()` Returns the internal name of the current channel.
`org.cyclos.impl.system.ChannelSettingsAccessor`	`getChannelSettingsAccessor()` Returns the accessor for the current channel (i.e the channel used to run the service method) general settings.
`ConfigurationAccessor`	`getConfiguration()` Returns the configuration accessor
`Group`	`getGroup()` Returns the group of the authenticated user, if any
`BasicUser`	`getLoggedBasicUser()` Returns the authenticated basic user, or null if none
`Operator`	`getLoggedOperator()` Returns the authenticated operator, or null if none or the logged is not an operator
`User`	`getLoggedUser()` Returns the authenticated user, or null if none
`Network`	`getNetwork()` Returns the network this session is using, or null if as global system or administrator
`Pin`	`getPin()` Returns the `Pin` used for this session only if the user was authenticated using such mechanism.
`org.cyclos.impl.users.ProductsAccessor`	`getProducts()` Returns the products accessor
`java.lang.String`	`getRemoteAddress()` Returns the remote address, of the client accessing the application
`RequestData`	`getRequestData()` Returns data about the calling request.
`Session`	`getSession()` Returns the session in case this session data performed a login
`org.cyclos.impl.access.SessionDataSubjectId`	`getSubjectId()` Returns the subject id
`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`	`isAdminOf(BasicUser user)` Returns whether the current user is an administrator of the given user
`boolean`	`isBrokerOf(BasicUser user)` Returns whether the current user is a broker of the given user
`boolean`	`isGlobalAdminInNetwork()` Returns whether a global admin OR a global restricted has switched to a network.
`boolean`	`isGuest()` Returns whether the current session represents a guest
`boolean`	`isLoggedIn()` Returns whether the current session represents a user
`boolean`	`isManagerOf(BasicUser user)` Returns whether the current user is a manager of the given user and is not the given user.
`boolean`	`isMemberOnly()` Returns true if the logged user has only `Role` member.
`boolean`	`isMultiNetworkAdminInGlobalMode()` Returns whether a global restricted has not switched to a network.
`boolean`	`isOwnerOf(BasicUser operator)` Returns whether current user is either the owner member of a given operator or as another alias operator
`default boolean`	`isRest()` Returns whether this session was initiated from a REST request
`boolean`	`isScript()` Returns whether this session is running under a script
`boolean`	`isSystem()` Returns whether the current session represents a system task
`boolean`	`isVisible(org.cyclos.impl.access.EntityCheck<SimpleEntity> entityCheck, SimpleEntity entity)` Returns whether the given entity is visible under the given entity check
`boolean`	`manages(BasicUser user)` Returns whether the current user manages the given user.
`boolean`	`relatesTo(BasicUser user)` Returns whether the current user is related to (is allowed to view) the given user

Methods inherited from interface org.cyclos.entities.users.RoleContainer
isAdmin, isAliasOperator, isBroker, isGlobalAdmin, isMember, isNetworkAdmin, isOperator, isRestrictedOperator, isUserManager

Methods inherited from interface org.cyclos.impl.access.UserPrincipal
getAccessClient, getAccount, getBasicUser, getCustomFieldValue, getMobilePhone, getPrincipal, getPrincipalType, getToken

- Method Detail
  - checkConsistency
```
void checkConsistency()
               throws InvalidSessionDataException
```
    Checks for consistency. Called before invoking a service method, as system
    
    Throws:
    
    InvalidSessionDataException
  - getAccessChannel
```
Channel getAccessChannel()
```
    Returns the original channel (i.e the channel used to access Cyclos) this session is using
  - getAccessChannelName
```
java.lang.String getAccessChannelName()
```
    Returns the internal name of the original channel (i.e the channel used to access Cyclos) . Must be accessible outside transactions.
  - getAccessibleBasicGroups
```
java.util.Set<BasicGroup> getAccessibleBasicGroups()
```
    Returns the basic groups accessible by the current session
  - getAuthenticatedUser
```
UserAuthVO getAuthenticatedUser()
```
    Returns the user authentication data, or null if none
  - getChannel
```
Channel getChannel()
```
    Returns the current channel this session is using
  - getChannelAccessAccessor
```
org.cyclos.impl.system.ChannelAccessAccessor getChannelAccessAccessor()
```
    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.
  - getChannelName
```
java.lang.String getChannelName()
```
    Returns the internal name of the current channel. Must be accessible outside transactions.
  - getChannelSettingsAccessor
```
org.cyclos.impl.system.ChannelSettingsAccessor getChannelSettingsAccessor()
```
    Returns the accessor for the current channel (i.e the channel used to run the service method) general settings. Always uses the current configuration settings. For example, if a global administrator is switched to a network, will get the settings for the network administrators.
  - getConfiguration
```
ConfigurationAccessor getConfiguration()
```
    Returns the configuration accessor
  - getGroup
```
Group getGroup()
```
    Returns the group of the authenticated user, if any
  - getLoggedBasicUser
```
BasicUser getLoggedBasicUser()
```
    Returns the authenticated basic user, or null if none
  - getLoggedOperator
```
Operator getLoggedOperator()
```
    Returns the authenticated operator, or null if none or the logged is not an operator
  - getLoggedUser
```
User getLoggedUser()
```
    Returns the authenticated user, or null if none
  - getNetwork
```
Network getNetwork()
```
    Returns the network this session is using, or null if as global system or administrator
  - getPin
```
Pin getPin()
```
    Returns the Pin used for this session only if the user was authenticated using such mechanism.
  - getProducts
```
org.cyclos.impl.users.ProductsAccessor getProducts()
```
    Returns the products accessor
  - getRemoteAddress
```
java.lang.String getRemoteAddress()
```
    Returns the remote address, of the client accessing the application
  - getRequestData
```
RequestData getRequestData()
```
    Returns data about the calling request. Must be accessible outside transactions.
  - getSession
```
Session getSession()
```
    Returns the session in case this session data performed a login
  - getSubjectId
```
org.cyclos.impl.access.SessionDataSubjectId getSubjectId()
```
    Returns the subject id
  - hasPermission
```
boolean hasPermission(Permission permission)
```
    Returns whether the current user has the given permission
  - hasRequiredValue
```
boolean hasRequiredValue(Permission permission,
                         java.lang.Object value)
```
    Returns whether the current user has access to the given required value for the given permission
  - isAdminOf
```
boolean isAdminOf(BasicUser user)
```
    Returns whether the current user is an administrator of the given user
  - isBrokerOf
```
boolean isBrokerOf(BasicUser user)
```
    Returns whether the current user is a broker of the given user
  - isGlobalAdminInNetwork
```
boolean isGlobalAdminInNetwork()
```
    Returns whether a global admin OR a global restricted has switched to a network.
  - isGuest
```
boolean isGuest()
```
    Returns whether the current session represents a guest
  - isLoggedIn
```
boolean isLoggedIn()
```
    Returns whether the current session represents a user
  - isManagerOf
```
boolean isManagerOf(BasicUser user)
```
    Returns whether the current user is a manager of the given user and is not the given user.
  - isMemberOnly
```
boolean isMemberOnly()
```
    Returns true if the logged user has only Role member.
  - isMultiNetworkAdminInGlobalMode
```
boolean isMultiNetworkAdminInGlobalMode()
```
    Returns whether a global restricted has not switched to a network.
  - isOwnerOf
```
boolean isOwnerOf(BasicUser operator)
```
    Returns whether current user is either the owner member of a given operator or as another alias operator
  - isRest
```
default boolean isRest()
```
    Returns whether this session was initiated from a REST request
  - isScript
```
boolean isScript()
```
    Returns whether this session is running under a script
  - isSystem
```
boolean isSystem()
```
    Returns whether the current session represents a system task
  - isVisible
```
boolean isVisible(org.cyclos.impl.access.EntityCheck<SimpleEntity> entityCheck,
                  SimpleEntity entity)
```
    Returns whether the given entity is visible under the given entity check
  - manages
```
boolean manages(BasicUser user)
```
    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
```
boolean relatesTo(BasicUser user)
```
    Returns whether the current user is related to (is allowed to view) the given user

Interface SessionData

Method Summary

Methods inherited from interface org.cyclos.entities.users.RoleContainer

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

Method Detail

checkConsistency

getAccessChannel

getAccessChannelName

getAccessibleBasicGroups

getAuthenticatedUser

getChannel

getChannelAccessAccessor

getChannelName

getChannelSettingsAccessor

getConfiguration

getGroup

getLoggedBasicUser

getLoggedOperator

getLoggedUser

getNetwork

getPin

getProducts

getRemoteAddress

getRequestData

getSession

getSubjectId

hasPermission

hasRequiredValue

isAdminOf

isBrokerOf

isGlobalAdminInNetwork

isGuest

isLoggedIn

isManagerOf

isMemberOnly

isMultiNetworkAdminInGlobalMode

isOwnerOf

isRest

isScript

isSystem

isVisible

manages

relatesTo