Arp::System::Um::Commons::SessionInfo Class Reference

This class a SessionInfo instance with given role list More...

#include <SessionInfo.hpp>

Public Member Functions
ARP_CXX_SYMBOL_EXPORT	SessionInfo (void)=delete
	Constructs an SessionInfo instance.
ARP_CXX_SYMBOL_EXPORT	SessionInfo (const std::list< String > &roles)
ARP_CXX_SYMBOL_EXPORT	SessionInfo (const String &username, uint32 gwID, const String &protolObjName, uint8 secMode, uint32 securityToken)
	Constructs a SessionInfo instance with given user, gatewayId, protocolObjectName, securityMode, securityToken.
ARP_CXX_SYMBOL_EXPORT	SessionInfo (const SessionInfo &arg)
	Copy constructor.
ARP_CXX_SYMBOL_EXPORT	SessionInfo (SessionInfo &&arg) noexcept
	Move constructor.
ARP_CXX_SYMBOL_EXPORT SessionInfo &	operator= (const SessionInfo &arg)
	Copy-assignment operator.
ARP_CXX_SYMBOL_EXPORT SessionInfo &	operator= (SessionInfo &&arg) noexcept
	Move-assignment operator.
ARP_CXX_SYMBOL_EXPORT	~SessionInfo (void)
	Destructs this instance and frees all resources.
ARP_CXX_SYMBOL_EXPORT const String &	GetUserName () const
	Returns current user of the session
ARP_CXX_SYMBOL_EXPORT const std::list< String > &	GetRoles () const
	Returns the set of roles associated with the session
ARP_CXX_SYMBOL_EXPORT const String &	GetProtocolObjName () const
	Returns the protocol object name of the channel
ARP_CXX_SYMBOL_EXPORT uint32	GetGatewayID () const
	Returns the gateway id of the channel
ARP_CXX_SYMBOL_EXPORT uint8	GetSecurityMode () const
	Returns the security mode of the channel
ARP_CXX_SYMBOL_EXPORT uint32	GetSecurityToken () const
	Returns a unique identification of this session
ARP_CXX_SYMBOL_EXPORT void	SetRoles (const std::list< String > &roles)
	Sets the list of roles. Note, the role list of SessionInfo is not synchronized with the list of roles in Session, so this function should only be used when a new session is initialized.
ARP_CXX_SYMBOL_EXPORT String	GetExtensionProperty (const String &key) const
	Returns custom security-related propertiy. If key does not exist, throws std::out_of_range.
ARP_CXX_SYMBOL_EXPORT bool	TryGetExtensionProperty (const String &key, String &value) const
	Tries to get custom security-related property. This never throws an exception. More...
ARP_CXX_SYMBOL_EXPORT bool	DeleteExtensionProperty (const String &key)
	Deletes a custom security-related property. This never throws an exception. More...
ARP_CXX_SYMBOL_EXPORT void	SetExtensionProperty (const String &key, const String &value)
	This can be used by a module implementation to add custom security-related properties.

Detailed Description

This class a SessionInfo instance with given role list

Member Function Documentation

DeleteExtensionProperty()

ARP_CXX_SYMBOL_EXPORT bool Arp::System::Um::Commons::SessionInfo::DeleteExtensionProperty

(

const String &

key

)

Deletes a custom security-related property. This never throws an exception.

Parameters

key	The property name

Returns

True if the property existed in the std::map

TryGetExtensionProperty()

ARP_CXX_SYMBOL_EXPORT bool Arp::System::Um::Commons::SessionInfo::TryGetExtensionProperty	(	const String &	key,
		String &	value
	)		const

Tries to get custom security-related property. This never throws an exception.

Parameters

key	The property name
value	Return value for the property

Returns

True if the property exists in the std::map

---

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

• Arp/System/Um/Commons/SessionInfo.hpp
• Arp/System/Um/Commons/SessionInfo.cpp