org.cyclos.impl.access

Class SystemSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

org.cyclos.impl.access.SystemSessionData

All Implemented Interfaces:

RoleContainer, SessionData

public class SystemSessionData
extends AbstractSessionData

A session data for running tasks as system

Author:

luis

Field Summary

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

requestData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SystemSessionData(RequestData requestData, java.lang.String channel)

Method Summary

Modifier and Type	Method and Description
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.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(RequestData data)
static SystemSessionData	getInstance(RequestData data, java.lang.String channel)
BasicUser	getLoggedBasicUser() Returns the authenticated basic user, or null if none
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	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
java.lang.String	toString()

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

bean, checkConsistency, doGetConfigurationAccessor, doGetPreferredLocales, getApplicationContext, getChannel, getConfiguration, getConfigurationEntity, getLoggedUser, getNetwork, getPrincipal, getProducts, getRawEntityManagerHandler, getRemoteAddress, getRequestData, getSession, isAdmin, isAdminOf, isAliasOperator, isBroker, isBrokerOf, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isManagerOf, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRestrictedOperator, isScript, isUserManager, resolveNetworkId, runAsSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemSessionData

protected SystemSessionData(RequestData requestData,
                            java.lang.String channel)

Method Detail

getInstance

public static SystemSessionData getInstance(RequestData data)

getInstance

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

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.

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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