org.cyclos.impl.access

Class ScriptSessionData

java.lang.Object

org.cyclos.impl.access.ScriptSessionData

All Implemented Interfaces:

SessionData

public class ScriptSessionData
extends java.lang.Object
implements SessionData

Session data used to run scripts. Will wrap another SessionData, and grant all permissions

Author:

luis

Constructor Summary

Constructors

Constructor and Description
ScriptSessionData(SessionData delegate)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConsistency() Checks for consistency.
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
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
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.
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	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 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptSessionData

public ScriptSessionData(SessionData delegate)

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

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.

Specified by:

getAccessClient in interface SessionData

getAccessibleBasicGroups

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

Description copied from interface: SessionData

Returns the basic groups accessible by the current session

Specified by:

getAccessibleBasicGroups in interface SessionData

getAuthenticatedUser

public UserAuthVO getAuthenticatedUser()

Description copied from interface: SessionData

Returns the user authentication data, or null if none

Specified by:

getAuthenticatedUser in interface SessionData

getChannel

public Channel getChannel()

Description copied from interface: SessionData

Returns the channel this session is using

Specified by:

getChannel in interface SessionData

getChannelConfiguration

public ChannelConfiguration getChannelConfiguration()

Description copied from interface: SessionData

Returns the channel configuration accessor

Specified by:

getChannelConfiguration in interface SessionData

getChannelName

public java.lang.String getChannelName()

Description copied from interface: SessionData

Returns the internal name of the current channel. Must be accessible outside transactions.

Specified by:

getChannelName in interface SessionData

getConfiguration

public ConfigurationAccessor getConfiguration()

Description copied from interface: SessionData

Returns the configuration accessor

Specified by:

getConfiguration in interface SessionData

getGroup

public Group getGroup()

Description copied from interface: SessionData

Returns the group of the authenticated user, if any

Specified by:

getGroup in interface SessionData

getLoggedBasicUser

public BasicUser getLoggedBasicUser()

Description copied from interface: SessionData

Returns the authenticated basic user, or null if none

Specified by:

getLoggedBasicUser in interface SessionData

getLoggedUser

public User getLoggedUser()

Description copied from interface: SessionData

Returns the authenticated user, or null if none

Specified by:

getLoggedUser in interface SessionData

getNetwork

public Network getNetwork()

Description copied from interface: SessionData

Returns the network this session is using, or null if as global system or administrator

Specified by:

getNetwork in interface SessionData

getPrincipalType

public PrincipalType getPrincipalType()

Description copied from interface: SessionData

Returns the principal type used for the current session.

Specified by:

getPrincipalType in interface SessionData

getProducts

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

Description copied from interface: SessionData

Returns the products accessor

Specified by:

getProducts in interface SessionData

getRemoteAddress

public java.lang.String getRemoteAddress()

Description copied from interface: SessionData

Returns the remote address, of the client accessing the application

Specified by:

getRemoteAddress in interface SessionData

getRequestData

public RequestData getRequestData()

Description copied from interface: SessionData

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

Specified by:

getRequestData in interface SessionData

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.

Specified by:

getToken in interface SessionData

hasPermission

public boolean hasPermission(Permission permission)

Description copied from interface: SessionData

Returns whether the current user has the given permission

Specified by:

hasPermission in interface SessionData

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

Specified by:

hasRequiredValue in interface SessionData

hasRole

public boolean hasRole(Role role)

Description copied from interface: SessionData

Returns whether the current user has the given role

Specified by:

hasRole in interface SessionData

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

Specified by:

isVisible in interface SessionData

manages

public boolean manages(BasicUser user)

Description copied from interface: SessionData

Returns whether the current user manages the given user

Specified by:

manages in interface SessionData

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

Specified by:

relatesTo in interface SessionData