UserManager Service to retrieve and set session properties like sessionId and extended session informations More...

#include <ISessionService.hpp>

Inheritance diagram for Arp::System::Um::Services::ISessionService:

Public Types
using	Ptr = std::shared_ptr< ISessionService >

Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	ISessionService (void)=default
	Constructs an ISessionService instance. More...

virtual boolean	GetSessionId (SecurityToken securityToken, RscString< 128 > &sessionId)=0
	Gets a sessionId (strong security Token) for a Um session. More...

virtual boolean	GetSecurityTokenFromSessionId (const RscString< 128 > &sessionId, SecurityToken &securityToken)=0
	Searchs for a Um Session identified by a StrongSecurityToken. If a valid session was found the Um securityToken is returned in parameter securityToken More...

virtual boolean	GetSessionProperty (SecurityToken securityToken, const RscString< 128 > &key, RscString< 128 > &value)=0
	Read a named property from a Um session. A property is extended information bound to a um session identified by a key. Example the user which opened the session. More...

virtual boolean	SetSessionProperty (SecurityToken securityToken, const RscString< 128 > &key, const RscString< 128 > &value)=0
	Sets a named property for a Um session. A property is extended information bound to a um session identified by a key. Example the user which opened the session. More...

virtual boolean	DeleteSessionProperty (SecurityToken securityToken, const RscString< 128 > &key)=0
	Deletes a named property for a Um session. More...

virtual boolean	IsSessionActive (SecurityToken securityToken)=0
	Check if the um session is active or not. More...

Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance. More...

virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces. More...

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)

Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of the service More...

Detailed Description

UserManager Service to retrieve and set session properties like sessionId and extended session informations

This service is only usable from the SDK for other processes running on the PLC; it is not intended for public use over RSC.

Constructor & Destructor Documentation

◆ ISessionService()

Arp::System::Um::Services::ISessionService::ISessionService ( void )

default

Constructs an ISessionService instance.

Member Function Documentation

◆ DeleteSessionProperty()

virtual boolean Arp::System::Um::Services::ISessionService::DeleteSessionProperty	(	SecurityToken	securityToken,
		const RscString< 128 > &	key
	)

pure virtual

Deletes a named property for a Um session.

Parameters

securityToken	the um securityToken identifying the session
key	key identifying the extended info which should be deleted

Returns: false if the strongSecurityToken is not valid, true if securityToken is returned

◆ GetSecurityTokenFromSessionId()

virtual boolean Arp::System::Um::Services::ISessionService::GetSecurityTokenFromSessionId	(	const RscString< 128 > &	sessionId,
		SecurityToken &	securityToken
	)

pure virtual

Searchs for a Um Session identified by a StrongSecurityToken. If a valid session was found the Um securityToken is returned in parameter securityToken

Parameters

sessionId	The strong sessionId to search for
securityToken	returns the securityToken for the Um session

Returns: false if the strongSecurityToken is not valid, true if securityToken is returned

◆ GetSessionId()

virtual boolean Arp::System::Um::Services::ISessionService::GetSessionId	(	SecurityToken	securityToken,
		RscString< 128 > &	sessionId
	)

pure virtual

Gets a sessionId (strong security Token) for a Um session.

Parameters

securityToken	Um Security token identifying the session
sessionId	returns the strongToken, only valid, if true is returned, Should be ignored otherwise

Returns: false if the securityToken is not valid, true if strongSecurityToken is returned

◆ GetSessionProperty()

virtual boolean Arp::System::Um::Services::ISessionService::GetSessionProperty	(	SecurityToken	securityToken,
		const RscString< 128 > &	key,
		RscString< 128 > &	value
	)

pure virtual

Read a named property from a Um session. A property is extended information bound to a um session identified by a key. Example the user which opened the session.

Parameters

securityToken	the um securityToken identifying the session
key	key identifying the extended info
value	value of the session information identifying by key

Returns: false if the securityToken is not valid, true if securityToken is valid. Note: if the property is not set for this session an empty string is returned.

◆ IsSessionActive()

virtual boolean Arp::System::Um::Services::ISessionService::IsSessionActive ( SecurityToken securityToken )

pure virtual

Check if the um session is active or not.

Parameters

securityToken Security token of the session to be checked

Returns: An indication whether the session is active.

◆ SetSessionProperty()

virtual boolean Arp::System::Um::Services::ISessionService::SetSessionProperty	(	SecurityToken	securityToken,
		const RscString< 128 > &	key,
		const RscString< 128 > &	value
	)

pure virtual

Sets a named property for a Um session. A property is extended information bound to a um session identified by a key. Example the user which opened the session.

Parameters

securityToken	the um securityToken identifying the session
key	key identifying the extended info
value	value to set as extended info for the um session

Returns: false if the securityToken is not valid, true if securityToken is valid.

The documentation for this class was generated from the following file:

Arp/System/Um/Services/ISessionService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ISessionService()

Member Function Documentation

◆ DeleteSessionProperty()

◆ GetSecurityTokenFromSessionId()

◆ GetSessionId()

◆ GetSessionProperty()

◆ IsSessionActive()

◆ SetSessionProperty()