ScriptSessionData (Cyclos 4.6 Scripting API Documentation)

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

All Implemented Interfaces:

RoleContainer, SessionData
```
public class ScriptSessionData
extends AbstractSessionData
```
Session data used to run scripts.
It wraps another SessionData preserving the logged user. If it must run as system then it has all permissions and it's related to all users (like system does). Otherwise it behaves as the wrapped session.

Author:

luis, ameyer

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

Constructor Summary

Constructors
Constructor and Description

ScriptSessionData(SessionData delegate, boolean runAsSystem)

Constructors
Constructor and Description
`ScriptSessionData(SessionData delegate, boolean runAsSystem)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkConsistency()` Checks for consistency.
`protected java.lang.Long`	`doGetConfigurationId()`
`protected org.cyclos.impl.users.ProductsAccessor`	`doGetProducts()` Must be implemented to return a a valid `ProductsAccessor`
`AccessClient`	`getAccessClient()` Return the current access client only if `SessionData.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
`ChannelConfiguration`	`getChannelConfiguration()` Returns the channel configuration accessor
`java.lang.String`	`getChannelName()` Returns the internal name of the current channel.
`SessionData`	`getDelegate()`
`Group`	`getGroup()` Returns the group of the authenticated user, if any
`BasicUser`	`getLoggedBasicUser()` Returns the authenticated basic user, or null if none
`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.
`Token`	`getToken()` Return the current token only if `SessionData.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`	`isAdmin()` Returns whether the `Role.ADMIN` is granted
`boolean`	`isAdminOf(BasicUser user)` Returns whether the current user is an administrator of the given user
`boolean`	`isBroker()` Returns whether the `Role.BROKER` is granted
`boolean`	`isBrokerOf(BasicUser user)` Returns whether the current user is a broker of the given user
`boolean`	`isGlobalAdmin()` Returns whether the `Role.GLOBAL_ADMIN` is granted
`boolean`	`isGuest()` Returns whether the current session represents a guest
`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`	`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 class org.cyclos.impl.access.AbstractSessionData
bean, doGetConfigurationAccessor, doGetPreferredLocales, getApplicationContext, getChannel, getConfiguration, getConfigurationEntity, getLoggedUser, getNetwork, getProducts, getRawEntityManagerHandler, getRemoteAddress, getRequestData, getSession, isAliasOperator, isGlobalAdminInNetwork, isManagerOf, isRestrictedOperator, isUserManager, resolveNetworkId, runAsSystem

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScriptSessionData
```
public ScriptSessionData(SessionData delegate,
                         boolean runAsSystem)
```
- 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
  - getAccessClient
```
public AccessClient getAccessClient()
```
    Description copied from interface: SessionData
    
    Return the current access client only if SessionData.getPrincipalType() return an instance of AccessClientPrincipalType. Otherwise it returns null.
  - 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
  - getChannelName
```
public java.lang.String getChannelName()
```
    Description copied from interface: SessionData
    
    Returns the internal name of the current channel. Must be accessible outside transactions.
  - getDelegate
```
public SessionData getDelegate()
```
  - getGroup
```
public Group getGroup()
```
    Description copied from interface: SessionData
    
    Returns the group of the authenticated user, if any
  - getLoggedBasicUser
```
public BasicUser getLoggedBasicUser()
```
    Description copied from interface: SessionData
    
    Returns the authenticated basic user, or null if none
  - getPrincipal
```
public java.lang.String getPrincipal()
```
    Description copied from interface: SessionData
    
    Returns the principal used to access this session, if any
    
    Specified by:
    
    getPrincipal in interface SessionData
    
    Overrides:
    
    getPrincipal in class AbstractSessionData
  - getPrincipalType
```
public PrincipalType getPrincipalType()
```
    Description copied from interface: SessionData
    
    Returns the principal type used for the current session.
    
    Specified by:
    
    getPrincipalType in interface SessionData
    
    Overrides:
    
    getPrincipalType in class AbstractSessionData
  - getToken
```
public Token getToken()
```
    Description copied from interface: SessionData
    
    Return the current token only if SessionData.getPrincipalType() return an instance of TokenPrincipalType. Otherwise it returns null.
  - 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 user)
```
    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
  - 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 user)
```
    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
  - isGuest
```
public boolean isGuest()
```
    Description copied from interface: SessionData
    
    Returns whether the current session represents a guest
    
    Specified by:
    
    isGuest in interface SessionData
    
    Overrides:
    
    isGuest 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
  - isScript
```
public boolean isScript()
```
    Description copied from interface: SessionData
    
    Returns whether this session is running under a script
    
    Specified by:
    
    isScript in interface SessionData
    
    Overrides:
    
    isScript in class AbstractSessionData
  - isSystem
```
public boolean isSystem()
```
    Description copied from interface: SessionData
    
    Returns whether the current session represents a system task
    
    Specified by:
    
    isSystem in interface SessionData
    
    Overrides:
    
    isSystem 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 user)
```
    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 user)
```
    Description copied from interface: SessionData
    
    Returns whether the current user is related to (is allowed to view) the given user
  - doGetConfigurationId
```
protected java.lang.Long doGetConfigurationId()
```
    Specified by:
    
    doGetConfigurationId in class AbstractSessionData
  - doGetProducts
```
protected 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

Class ScriptSessionData

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

Constructor Detail

ScriptSessionData

Method Detail

checkConsistency

getAccessClient

getAccessibleBasicGroups

getAuthenticatedUser

getChannelConfiguration

getChannelName

getDelegate

getGroup

getLoggedBasicUser

getPrincipal

getPrincipalType

getToken

hasPermission

hasRequiredValue

isAdmin

isAdminOf

isBroker

isBrokerOf

isGlobalAdmin

isGuest

isLoggedIn

isMember

isMemberOnly

isNetworkAdmin

isOperator

isScript

isSystem

isVisible

manages

relatesTo

doGetConfigurationId

doGetProducts