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

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)

ARP_CXX_SYMBOL_EXPORT	SessionInfo (const SessionInfo &arg)
	Copy constructor. More...

ARP_CXX_SYMBOL_EXPORT	SessionInfo (SessionInfo &&arg) noexcept
	Move constructor. More...

ARP_CXX_SYMBOL_EXPORT SessionInfo &	operator= (const SessionInfo &arg)
	Copy-assignment operator. More...

ARP_CXX_SYMBOL_EXPORT SessionInfo &	operator= (SessionInfo &&arg) noexcept
	Move-assignment operator. More...

ARP_CXX_SYMBOL_EXPORT	~SessionInfo (void)
	Destructs this instance and frees all resources. More...

ARP_CXX_SYMBOL_EXPORT const String &	GetUserName () const
	Returns current user of the session More...

ARP_CXX_SYMBOL_EXPORT const std::list< String > &	GetRoles () const
	Returns the set of roles associated with the session More...

ARP_CXX_SYMBOL_EXPORT const String &	GetProtocolObjName () const
	Returns the protocol object name of the channel More...

ARP_CXX_SYMBOL_EXPORT uint32	GetGatewayID () const
	Returns the gateway id of the channel More...

ARP_CXX_SYMBOL_EXPORT uint8	GetSecurityMode () const
	Returns the security mode of the channel More...

ARP_CXX_SYMBOL_EXPORT uint32	GetSecurityToken () const
	Returns a unique identification of this session More...

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

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

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

Detailed Description

This class a SessionInfo instance with given role list

Constructor & Destructor Documentation

◆ SessionInfo() [1/3]

ARP_CXX_SYMBOL_EXPORT Arp::System::Um::Commons::SessionInfo::SessionInfo ( void )

delete

Constructs an SessionInfo instance.

◆ SessionInfo() [2/3]

ARP_CXX_SYMBOL_EXPORT Arp::System::Um::Commons::SessionInfo::SessionInfo ( const SessionInfo & arg )

Copy constructor.

◆ SessionInfo() [3/3]

ARP_CXX_SYMBOL_EXPORT Arp::System::Um::Commons::SessionInfo::SessionInfo ( SessionInfo && arg )

noexcept

Move constructor.

◆ ~SessionInfo()

ARP_CXX_SYMBOL_EXPORT Arp::System::Um::Commons::SessionInfo::~SessionInfo ( void )

Destructs this instance and frees all resources.

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 map

◆ GetExtensionProperty()

ARP_CXX_SYMBOL_EXPORT String Arp::System::Um::Commons::SessionInfo::GetExtensionProperty ( const String & key ) const

Returns custom security-related propertiy. If key does not exist, throws std::out_of_range.

◆ GetGatewayID()

ARP_CXX_SYMBOL_EXPORT uint32 Arp::System::Um::Commons::SessionInfo::GetGatewayID ( ) const

Returns the gateway id of the channel

◆ GetProtocolObjName()

ARP_CXX_SYMBOL_EXPORT const String& Arp::System::Um::Commons::SessionInfo::GetProtocolObjName ( ) const

Returns the protocol object name of the channel

◆ GetRoles()

ARP_CXX_SYMBOL_EXPORT const std::list<String>& Arp::System::Um::Commons::SessionInfo::GetRoles ( ) const

Returns the set of roles associated with the session

◆ GetSecurityMode()

ARP_CXX_SYMBOL_EXPORT uint8 Arp::System::Um::Commons::SessionInfo::GetSecurityMode ( ) const

Returns the security mode of the channel

◆ GetSecurityToken()

ARP_CXX_SYMBOL_EXPORT uint32 Arp::System::Um::Commons::SessionInfo::GetSecurityToken ( ) const

Returns a unique identification of this session

◆ GetUserName()

ARP_CXX_SYMBOL_EXPORT const String& Arp::System::Um::Commons::SessionInfo::GetUserName ( ) const

Returns current user of the session

◆ operator=() [1/2]

ARP_CXX_SYMBOL_EXPORT SessionInfo& Arp::System::Um::Commons::SessionInfo::operator= ( const SessionInfo & arg )

Copy-assignment operator.

◆ operator=() [2/2]

ARP_CXX_SYMBOL_EXPORT SessionInfo& Arp::System::Um::Commons::SessionInfo::operator= ( SessionInfo && arg )

noexcept

Move-assignment operator.

◆ SetExtensionProperty()

ARP_CXX_SYMBOL_EXPORT void Arp::System::Um::Commons::SessionInfo::SetExtensionProperty	(	const String &	key,
		const String &	value
	)

This can be used by a module implementation to add custom security-related properties.

◆ SetRoles()

ARP_CXX_SYMBOL_EXPORT void Arp::System::Um::Commons::SessionInfo::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.

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