org.cyclos.impl.access

Class SystemSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

org.cyclos.impl.access.SystemSessionData

All Implemented Interfaces:

SessionData

public class SystemSessionData
extends AbstractSessionData

A session data for running tasks as system

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
protected ConfigurationAccessor	doGetConfigurationAccessor()
protected java.lang.Long	doGetConfigurationId()
AccessClient	getAccessClient() Return the current access client only if SessionData.getPrincipalType() return an instance of AccessClientPrincipalType.
java.util.List<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.
Group	getGroup() Returns the group of the authenticated user, if any
static SystemSessionData	getInstance()
static SystemSessionData	getInstance(RequestData data)
static SystemSessionData	getInstance(RequestData data, java.lang.String channel)
static SystemSessionData	getInstance(RequestData data, java.lang.String channel, java.util.List<java.util.Locale> locales)
BasicUser	getLoggedBasicUser() Returns the authenticated basic user, or null if none
PrincipalType	getPrincipalType() Returns the principal type used for the current session.
org.cyclos.impl.users.ProductsAccessor	getProducts() Returns the products accessor
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
java.lang.String	toString()

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

bean, checkConsistency, getApplicationContext, getChannel, getConfiguration, getConfigurationEntity, getLoggedUser, getNetwork, getRawEntityManagerHandler, getRemoteAddress, resolveNetworkId

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SystemSessionData getInstance()

getInstance

public static SystemSessionData getInstance(RequestData data)

getInstance

public static SystemSessionData getInstance(RequestData data,
                            java.lang.String channel)

getInstance

public static SystemSessionData getInstance(RequestData data,
                            java.lang.String channel,
                            java.util.List<java.util.Locale> locales)

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.List<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.

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

getPrincipalType

public PrincipalType getPrincipalType()

Description copied from interface: SessionData

Returns the principal type used for the current session.

getProducts

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

Description copied from interface: SessionData

Returns the products accessor

getRequestData

public RequestData getRequestData()

Description copied from interface: SessionData

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

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

hasRole

public boolean hasRole(Role role)

Description copied from interface: SessionData

Returns whether the current user has the given role

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

manages

public boolean manages(BasicUser user)

Description copied from interface: SessionData

Returns whether the current user manages the given user

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

doGetConfigurationAccessor

protected ConfigurationAccessor doGetConfigurationAccessor()

Overrides:

doGetConfigurationAccessor in class AbstractSessionData

doGetConfigurationId

protected java.lang.Long doGetConfigurationId()

Specified by:

doGetConfigurationId in class AbstractSessionData