Package org.cyclos.impl.access

Class AbstractSessionData

java.lang.Object

org.cyclos.impl.access.AbstractSessionData

All Implemented Interfaces:

RoleContainer, DelegatingUserPrincipal, SessionData, UserPrincipal

Direct Known Subclasses:

GuestSessionData, ScriptSessionData, SystemSessionData, UserSessionData

public abstract class AbstractSessionData
extends Object
implements SessionData

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractSessionData.SessionDataChannelAccessAccessor

Field Summary

Fields

Modifier and Type	Field	Description
protected RequestData	requestData

Constructor Summary

Constructors

Constructor	Description
AbstractSessionData(RequestData requestData)

Method Summary

Modifier and Type	Method	Description
protected <T> T	bean(Class<T> beanClass)
void	checkConsistency()	Checks for consistency.
protected ConfigurationAccessor	doGetConfigurationAccessor()
protected abstract Long	doGetConfigurationId()
protected List<String>	doGetPreferredLocales()
protected abstract ProductsAccessor	doGetProducts()	Must be implemented to return a a valid ProductsAccessor
protected abstract SessionDataSubjectId	doGetSubjectId()
protected abstract boolean	doHasPermission(Permission permission)
Channel	getAccessChannel()	Returns the original channel (i.e the channel used to access Cyclos) this session is using
AccessClient	getAccessClient()
OidcAccessToken	getAccessToken()	Returns the OpenID Connect / OAuth2 access token for this session
UserAccount	getAccount()
protected ApplicationContext	getApplicationContext()
BasicUser	getBasicUser()
Channel	getChannel()	Returns the current channel this session is using
ChannelAccessAccessor	getChannelAccessAccessor()	Returns the accessor for the access channel (i.e the original channel used to access Cyclos) access settings.
ChannelConfiguration	getChannelConfiguration()	This method is here, but not in the interface.
ChannelSettingsAccessor	getChannelSettingsAccessor()	Returns the accessor for the current channel (i.e the channel used to run the service method) general settings.
ConfigurationAccessor	getConfiguration()	Returns the configuration accessor
protected Configuration	getConfigurationEntity()
UserCustomFieldValue	getCustomFieldValue()
IdentityProvider	getIdentityProvider()	Returns the IdentityProvider used for this session only if the user was authenticated using such mechanism.
Operator	getLoggedOperator()	Returns the authenticated operator, or null if none or the logged is not an operator
User	getLoggedUser()	Returns the authenticated user, or null if none
MobilePhone	getMobilePhone()
Network	getNetwork()	Returns the network this session is using, or null if as global system or administrator
Pin	getPin()	Returns the Pin used for this session only if the user was authenticated using such mechanism.
String	getPrincipal()	Should return a value that can be used to identify the user.
PrincipalType	getPrincipalType()
ProductsAccessor	getProducts()	Returns the products accessor
protected RawEntityManagerHandler	getRawEntityManagerHandler()
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
SessionDataSubjectId	getSubjectId()	Returns the subject id
Token	getToken()
TrustedDevice	getTrustedDevice()
boolean	hasPermission(Permission permission)	Returns whether the current user has the given permission
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 Returns true if the user is the "root" user.
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 a 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	isMultiNetworkAdminInGlobalMode()	Returns whether a global restricted has not switched to a network.
boolean	isNetworkAdmin()	Returns whether the Role.NETWORK_ADMIN is granted
boolean	isOperator()	Returns whether the Role.OPERATOR is granted
boolean	isOwnerOf(BasicUser operator)	Returns whether current user is either the owner member of a given operator or as another alias operator
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	isTrusted()	Returns whether this session should be considered trusted
boolean	isUserManager()	Returns whether the Role.ADMIN or Role.BROKER roles are granted
protected Long	resolveNetworkId()
protected <T> T	runAsSystem(Callable<T> callable)	Runs the given callable as system, with the same request data and channel as this session data
protected <T> T	runAsSystem(Callable<T> callable, boolean useCurrentChannelName)

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

getDelegate

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

getAccessChannelName, getAccessibleBasicGroups, getAuthenticatedUser, getChannelName, getGroup, getLoggedBasicUser, hasPermission, hasRequiredValue, isRest, 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

getAccessChannel

public final Channel getAccessChannel()

Description copied from interface: SessionData

Returns the original channel (i.e the channel used to access Cyclos) this session is using

Specified by:

getAccessChannel in interface SessionData

getAccessClient

public AccessClient getAccessClient()

Specified by:

getAccessClient in interface UserPrincipal

getAccessToken

public OidcAccessToken getAccessToken()

Description copied from interface: SessionData

Returns the OpenID Connect / OAuth2 access token for this session

Specified by:

getAccessToken in interface SessionData

getAccount

public UserAccount getAccount()

Specified by:

getAccount in interface UserPrincipal

getBasicUser

public BasicUser getBasicUser()

Specified by:

getBasicUser in interface UserPrincipal

getChannel

public final Channel getChannel()

Description copied from interface: SessionData

Returns the current channel this session is using

Specified by:

getChannel in interface SessionData

getChannelAccessAccessor

public ChannelAccessAccessor getChannelAccessAccessor()

Description copied from interface: SessionData

Returns the accessor for the access channel (i.e the original channel used to access Cyclos) access settings. Always uses the user's own settings. For example, if a global administrator is switched to a network, will get his settings, from global mode.

Specified by:

getChannelAccessAccessor in interface SessionData

getChannelConfiguration

public ChannelConfiguration getChannelConfiguration()

This method is here, but not in the interface. Session data for guests / system has a single channel configuration. Also, scripts might be using this method, so it keeps them working.

getChannelSettingsAccessor

public ChannelSettingsAccessor getChannelSettingsAccessor()

Description copied from interface: SessionData

Returns the accessor for the current channel (i.e the channel used to run the service method) general settings. Always uses the current configuration settings. For example, if a global administrator is switched to a network, will get the settings for the network administrators.

Specified by:

getChannelSettingsAccessor in interface SessionData

getConfiguration

public final ConfigurationAccessor getConfiguration()

Description copied from interface: SessionData

Returns the configuration accessor

Specified by:

getConfiguration in interface SessionData

getCustomFieldValue

public UserCustomFieldValue getCustomFieldValue()

Specified by:

getCustomFieldValue in interface UserPrincipal

getIdentityProvider

public IdentityProvider getIdentityProvider()

Description copied from interface: SessionData

Returns the IdentityProvider used for this session only if the user was authenticated using such mechanism.

Specified by:

getIdentityProvider in interface SessionData

getLoggedOperator

public final Operator getLoggedOperator()

Description copied from interface: SessionData

Returns the authenticated operator, or null if none or the logged is not an operator

Specified by:

getLoggedOperator 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

getMobilePhone

public MobilePhone getMobilePhone()

Specified by:

getMobilePhone in interface UserPrincipal

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

getPin

public Pin getPin()

Description copied from interface: SessionData

Returns the Pin used for this session only if the user was authenticated using such mechanism.

Specified by:

getPin in interface SessionData

getPrincipal

public String getPrincipal()

Description copied from interface: UserPrincipal

Should return a value that can be used to identify the user. In case the value should be hidden, implementors should return null.

Specified by:

getPrincipal in interface DelegatingUserPrincipal

Specified by:

getPrincipal in interface UserPrincipal

getPrincipalType

public PrincipalType getPrincipalType()

Specified by:

getPrincipalType in interface UserPrincipal

getProducts

public final ProductsAccessor getProducts()

Description copied from interface: SessionData

Returns the products accessor

Specified by:

getProducts in interface SessionData

getRemoteAddress

public 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

getSubjectId

public SessionDataSubjectId getSubjectId()

Description copied from interface: SessionData

Returns the subject id

Specified by:

getSubjectId in interface SessionData

getToken

public Token getToken()

Specified by:

getToken in interface UserPrincipal

getTrustedDevice

public TrustedDevice getTrustedDevice()

Specified by:

getTrustedDevice in interface UserPrincipal

hasPermission

public final boolean hasPermission(Permission permission)

Description copied from interface: SessionData

Returns whether the current user has the given permission

Specified by:

hasPermission 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 Returns true if the user is the "root" user. For multi-networks administrators it returns false

Specified by:

isGlobalAdmin in interface RoleContainer

See Also:

RoleContainer.isGlobalAdmin()

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 a 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

isMultiNetworkAdminInGlobalMode

public boolean isMultiNetworkAdminInGlobalMode()

Returns whether a global restricted has not switched to a network.

Specified by:

isMultiNetworkAdminInGlobalMode 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

isOwnerOf

public boolean isOwnerOf(BasicUser operator)

Description copied from interface: SessionData

Returns whether current user is either the owner member of a given operator or as another alias operator

Specified by:

isOwnerOf in interface SessionData

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

isTrusted

public boolean isTrusted()

Description copied from interface: SessionData

Returns whether this session should be considered trusted

Specified by:

isTrusted 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(Class<T> beanClass)

doGetConfigurationAccessor

protected ConfigurationAccessor doGetConfigurationAccessor()

doGetConfigurationId

protected abstract Long doGetConfigurationId()

doGetPreferredLocales

protected List<String> doGetPreferredLocales()

doGetProducts

protected abstract ProductsAccessor doGetProducts()

Must be implemented to return a a valid ProductsAccessor

doGetSubjectId

protected abstract SessionDataSubjectId doGetSubjectId()

doHasPermission

protected abstract boolean doHasPermission(Permission permission)

getApplicationContext

protected ApplicationContext getApplicationContext()

getConfigurationEntity

protected final Configuration getConfigurationEntity()

getRawEntityManagerHandler

protected RawEntityManagerHandler getRawEntityManagerHandler()

resolveNetworkId

protected Long resolveNetworkId()

runAsSystem

protected <T> T runAsSystem(Callable<T> callable)

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

runAsSystem

protected <T> T runAsSystem(Callable<T> callable,
                            boolean useCurrentChannelName)