Package org.cyclos.impl.access

Class SystemSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

org.cyclos.impl.access.SystemSessionData

All Implemented Interfaces:

RoleContainer, DelegatingUserPrincipal, SessionData, UserPrincipal

public class SystemSessionData
extends AbstractSessionData

A session data for running tasks as system

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.impl.access.AbstractSessionData

AbstractSessionData.SessionDataChannelAccessAccessor

Field Summary

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

requestData

Method Summary

Modifier and Type	Method	Description
protected Long	doGetConfigurationId()
protected ProductsAccessor	doGetProducts()	Must be implemented to return a a valid ProductsAccessor
protected SessionDataSubjectId	doGetSubjectId()
protected boolean	doHasPermission(Permission permission)
String	getAccessChannelName()	Returns the internal name of the original channel (i.e the channel used to access Cyclos) .
Set<BasicGroup>	getAccessibleBasicGroups()	Returns the basic groups accessible by the current session
UserAuthVO	getAuthenticatedUser()	Returns the user authentication data, or null if none
String	getChannelName()	Returns the internal name of the current channel.
Group	getGroup()	Returns the group of the authenticated user, if any
BasicUser	getLoggedBasicUser()	Returns the authenticated basic user, or null if none
PrincipalType	getPrincipalType()
boolean	hasRequiredValue(Permission permission, 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(EntityCheck<SimpleEntity> entityCheck, SimpleEntity 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
String	toString()

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

bean, checkConsistency, doGetConfigurationAccessor, doGetPreferredLocales, getAccessChannel, getAccessClient, getAccessToken, getAccount, getApplicationContext, getBasicUser, getChannel, getChannelAccessAccessor, getChannelConfiguration, getChannelSettingsAccessor, getConfiguration, getConfigurationEntity, getCustomFieldValue, getIdentityProvider, getLoggedOperator, getLoggedUser, getMobilePhone, getNetwork, getPin, getPrincipal, getProducts, getRawEntityManagerHandler, getRemoteAddress, getRequestData, getSession, getSubjectId, getToken, getTrustedDevice, hasPermission, isAdmin, isAdminOf, isAliasOperator, isBroker, isBrokerOf, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isManagerOf, isMember, isMemberOnly, isMultiNetworkAdminInGlobalMode, isNetworkAdmin, isOperator, isOwnerOf, isRestrictedOperator, isScript, isTrusted, isUserManager, resolveNetworkId, runAsSystem, runAsSystem

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.access.DelegatingUserPrincipal

getDelegate

Methods inherited from interface org.cyclos.impl.access.SessionData

hasPermission, isRest

Method Detail

getAccessChannelName

public String getAccessChannelName()

Description copied from interface: SessionData

Returns the internal name of the original channel (i.e the channel used to access Cyclos) . Must be accessible outside transactions.

getAccessibleBasicGroups

public Set<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

getChannelName

public 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()

Specified by:

getPrincipalType in interface UserPrincipal

Overrides:

getPrincipalType in class AbstractSessionData

hasRequiredValue

public boolean hasRequiredValue(Permission permission,
                                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(EntityCheck<SimpleEntity> entityCheck,
                         SimpleEntity 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 String toString()

Overrides:

toString in class Object

doGetConfigurationId

protected Long doGetConfigurationId()

Specified by:

doGetConfigurationId in class AbstractSessionData

doGetProducts

protected ProductsAccessor doGetProducts()

Description copied from class: AbstractSessionData

Must be implemented to return a a valid ProductsAccessor

Specified by:

doGetProducts in class AbstractSessionData

doGetSubjectId

protected SessionDataSubjectId doGetSubjectId()

Specified by:

doGetSubjectId in class AbstractSessionData

doHasPermission

protected boolean doHasPermission(Permission permission)

Specified by:

doHasPermission in class AbstractSessionData