SessionData (Cyclos 4.6 Scripting API Documentation)

All Superinterfaces:

RoleContainer

All Known Implementing Classes:

AbstractSessionData, AccessClientSessionData, DirectUserSessionData, GuestSessionData, ScriptSessionData, StatefulUserSessionData, StatelessUserSessionData, SystemSessionData, UserSessionData
```
public interface SessionData
extends RoleContainer
```
Contains data in a user session

Author:

luis

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`checkConsistency()` Checks for consistency.
`AccessClient`	`getAccessClient()` Return the current access client only if `getPrincipalType()` return an instance of `AccessClientPrincipalType`.
`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
`Channel`	`getChannel()` Returns the channel this session is using
`ChannelConfiguration`	`getChannelConfiguration()` Returns the channel configuration accessor
`java.lang.String`	`getChannelName()` Returns the internal name of the current channel.
`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
`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
`java.lang.String`	`getPrincipal()` Returns the principal used to access this session, if any
`PrincipalType`	`getPrincipalType()` Returns the principal type used for the current session.
`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
`Token`	`getToken()` Return the current token only if `getPrincipalType()` return an instance of `TokenPrincipalType`.
`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 an 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`	`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<BaseEntity> entityCheck, BaseEntity 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

- Method Detail
  - checkConsistency
```
void checkConsistency()
               throws InvalidSessionDataException
```
    Checks for consistency. Called before invoking a service method, as system
    
    Throws:
    
    InvalidSessionDataException
  - getAccessClient
```
AccessClient getAccessClient()
```
    Return the current access client only if getPrincipalType() return an instance of AccessClientPrincipalType. Otherwise it returns null.
  - getAccessibleBasicGroups
```
java.util.Collection<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 channel this session is using
  - getChannelConfiguration
```
ChannelConfiguration getChannelConfiguration()
```
    Returns the channel configuration accessor
  - getChannelName
```
java.lang.String getChannelName()
```
    Returns the internal name of the current channel. Must be accessible outside transactions.
  - 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
  - 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
  - getPrincipal
```
java.lang.String getPrincipal()
```
    Returns the principal used to access this session, if any
  - getPrincipalType
```
PrincipalType getPrincipalType()
```
    Returns the principal type used for the current session.
  - 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
  - getToken
```
Token getToken()
```
    Return the current token only if getPrincipalType() return an instance of TokenPrincipalType. Otherwise it returns null.
  - 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 an 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.
  - 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<BaseEntity> entityCheck,
                  BaseEntity 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

Method Detail

checkConsistency

getAccessClient

getAccessibleBasicGroups

getAuthenticatedUser

getChannel

getChannelConfiguration

getChannelName

getConfiguration

getGroup

getLoggedBasicUser

getLoggedUser

getNetwork

getPrincipal

getPrincipalType

getProducts

getRemoteAddress

getRequestData

getSession

getToken

hasPermission

hasRequiredValue

isAdminOf

isBrokerOf

isGlobalAdminInNetwork

isGuest

isLoggedIn

isManagerOf

isMemberOnly

isScript

isSystem

isVisible

manages

relatesTo