org.cyclos.impl.access

Class AbstractSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

All Implemented Interfaces:

RoleContainer, SessionData

Direct Known Subclasses:

GuestSessionData, ScriptSessionData, SystemSessionData, UserSessionData

public abstract class AbstractSessionData
extends java.lang.Object
implements SessionData

Base class for SessionData's implementations, containing logic that counts for any type of SessionData.

Author:

rinke

Field Summary

Fields

Modifier and Type	Field and Description
protected RequestData	requestData

Constructor Summary

Constructors

Constructor and Description
AbstractSessionData(RequestData requestData)

Method Summary

Modifier and Type	Method and Description
protected <T> T	bean(java.lang.Class<T> beanClass)
void	checkConsistency() Checks for consistency.
protected ConfigurationAccessor	doGetConfigurationAccessor()
protected abstract java.lang.Long	doGetConfigurationId()
protected java.util.List<java.lang.String>	doGetPreferredLocales()
protected abstract org.cyclos.impl.users.ProductsAccessor	doGetProducts() Must be implemented to return a a valid ProductsAccessor
protected org.springframework.context.ApplicationContext	getApplicationContext()
Channel	getChannel() Returns the channel this session is using
ConfigurationAccessor	getConfiguration() Returns the configuration accessor
protected Configuration	getConfigurationEntity()
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
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.
org.cyclos.impl.users.ProductsAccessor	getProducts() Returns the products accessor
protected RawEntityManagerHandler	getRawEntityManagerHandler()
java.lang.String	getRemoteAddress() Returns the remote address, of the client accessing the application
RequestData	getRequestData() Returns data about the calling request.
Session	getSession() Returns the session in case this session data performed a login
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	isAliasOperator() Returns whether the Role.ALIAS_OPERATOR is granted
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	isGlobalAdminInNetwork() Returns whether a global admin OR a global restricted has switched to a network.
boolean	isGuest() Returns whether the current session represents a guest
boolean	isLoggedIn() Returns whether the current session represents an user
boolean	isManagerOf(BasicUser user) Returns whether the current user is a manager of the given user and is not the given 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	isRestrictedOperator() Returns whether the Role.RESTRICTED_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	isUserManager() Returns whether the Role.ADMIN or Role.BROKER roles are granted
protected java.lang.Long	resolveNetworkId()
protected <T> T	runAsSystem(java.util.concurrent.Callable<T> callable) Runs the given callable as system, with the same request data and channel as this session data

Methods inherited from class java.lang.Object

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

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

getAccessClient, getAccessibleBasicGroups, getAuthenticatedUser, getChannelConfiguration, getChannelName, getGroup, getLoggedBasicUser, getToken, hasPermission, hasRequiredValue, isVisible, manages, relatesTo

Field Detail

requestData

protected final RequestData requestData

Constructor Detail

AbstractSessionData

public AbstractSessionData(RequestData requestData)

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

getChannel

public final Channel getChannel()

Description copied from interface: SessionData

Returns the channel this session is using

Specified by:

getChannel in interface SessionData

getConfiguration

public final ConfigurationAccessor getConfiguration()

Description copied from interface: SessionData

Returns the configuration accessor

Specified by:

getConfiguration in interface SessionData

getLoggedUser

public final User getLoggedUser()

Description copied from interface: SessionData

Returns the authenticated user, or null if none

Specified by:

getLoggedUser in interface SessionData

getNetwork

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

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

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 final 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 final RequestData getRequestData()

Description copied from interface: SessionData

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

Specified by:

getRequestData in interface SessionData

getSession

public Session getSession()

Description copied from interface: SessionData

Returns the session in case this session data performed a login

Specified by:

getSession in interface SessionData

isAdmin

public boolean isAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.ADMIN is granted

Specified by:

isAdmin in interface RoleContainer

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

isAliasOperator

public boolean isAliasOperator()

Description copied from interface: RoleContainer

Returns whether the Role.ALIAS_OPERATOR is granted

Specified by:

isAliasOperator in interface RoleContainer

isBroker

public boolean isBroker()

Description copied from interface: RoleContainer

Returns whether the Role.BROKER is granted

Specified by:

isBroker in interface RoleContainer

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

isGlobalAdmin

public boolean isGlobalAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.GLOBAL_ADMIN is granted

Specified by:

isGlobalAdmin in interface RoleContainer

isGlobalAdminInNetwork

public boolean isGlobalAdminInNetwork()

Returns whether a global admin OR a global restricted has switched to a network.

Specified by:

isGlobalAdminInNetwork in interface SessionData

isGuest

public boolean isGuest()

Description copied from interface: SessionData

Returns whether the current session represents a guest

Specified by:

isGuest in interface SessionData

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: SessionData

Returns whether the current session represents an user

Specified by:

isLoggedIn in interface SessionData

isManagerOf

public boolean isManagerOf(BasicUser user)

Description copied from interface: SessionData

Returns whether the current user is a manager of the given user and is not the given user.

Specified by:

isManagerOf in interface SessionData

isMember

public boolean isMember()

Description copied from interface: RoleContainer

Returns whether the Role.MEMBER is granted

Specified by:

isMember in interface RoleContainer

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

isNetworkAdmin

public boolean isNetworkAdmin()

Description copied from interface: RoleContainer

Returns whether the Role.NETWORK_ADMIN is granted

Specified by:

isNetworkAdmin in interface RoleContainer

isOperator

public boolean isOperator()

Description copied from interface: RoleContainer

Returns whether the Role.OPERATOR is granted

Specified by:

isOperator in interface RoleContainer

isRestrictedOperator

public boolean isRestrictedOperator()

Description copied from interface: RoleContainer

Returns whether the Role.RESTRICTED_OPERATOR is granted

Specified by:

isRestrictedOperator in interface RoleContainer

isScript

public boolean isScript()

Description copied from interface: SessionData

Returns whether this session is running under a script

Specified by:

isScript in interface SessionData

isSystem

public boolean isSystem()

Description copied from interface: SessionData

Returns whether the current session represents a system task

Specified by:

isSystem in interface SessionData

isUserManager

public boolean isUserManager()

Description copied from interface: RoleContainer

Returns whether the Role.ADMIN or Role.BROKER roles are granted

Specified by:

isUserManager in interface RoleContainer

bean

protected <T> T bean(java.lang.Class<T> beanClass)

doGetConfigurationAccessor

protected ConfigurationAccessor doGetConfigurationAccessor()

doGetConfigurationId

protected abstract java.lang.Long doGetConfigurationId()

doGetPreferredLocales

protected java.util.List<java.lang.String> doGetPreferredLocales()

doGetProducts

protected abstract org.cyclos.impl.users.ProductsAccessor doGetProducts()

Must be implemented to return a a valid ProductsAccessor

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()

getConfigurationEntity

protected final Configuration getConfigurationEntity()

getRawEntityManagerHandler

protected RawEntityManagerHandler getRawEntityManagerHandler()

resolveNetworkId

protected java.lang.Long resolveNetworkId()

runAsSystem

protected <T> T runAsSystem(java.util.concurrent.Callable<T> callable)

Runs the given callable as system, with the same request data and channel as this session data