Ict.Petra.Shared.Security.TPetraPrincipal Class Reference

Public Member Functions
	TPetraPrincipal ()
	default constructor for JsonConvert More...
	TPetraPrincipal (string AUserID, string[] AGroups=null, String[] AModuleAccess=null, String[] AFunctions=null, String[] ARoles=null)
	constructor More...
Boolean	IsInGroup (string AGroupName)
	tells if the user is part of the given group More...
Boolean	IsInRole (string ARoleName)
	tells if the user has the given role More...
Boolean	IsInModule (string AModuleName)
	check if user has access to the given module More...
Boolean	IsInLedger (Int32 ALedgerNumber)
	Check if user can access this ledger More...
string	GetPermissions ()
	diagnostic string to show which modules a user has been given access to (separated by newlines) More...

Properties
String	UserID [get, set]
	the current user id More...
Int64	PartnerKey [get, set]
	the partner key of this user More...
String	LoginMessage [get, set]
	login message can give system information to the user during login More...
Int32	ProcessID [get, set]
	process id of the client domain on the server??? todoComment More...
string[]	ModuleAccess [get, set]
	we need this for JSON serialization for the session More...
string[]	Groups [get, set]
	we need this for JSON serialization for the session More...

Detailed Description

The TPetraPrincipal class is a .NET Principal-derived representation of a User in the Petra DB with its Groups and Roles.

Constructor & Destructor Documentation

TPetraPrincipal() [1/2]

Ict.Petra.Shared.Security.TPetraPrincipal.TPetraPrincipal ( )

inline

default constructor for JsonConvert

TPetraPrincipal() [2/2]

Ict.Petra.Shared.Security.TPetraPrincipal.TPetraPrincipal ( string  AUserID, string[]  AGroups = null, String[]  AModuleAccess = null, String[]  AFunctions = null, String[]  ARoles = null  )

inline

constructor

Parameters

AUserID
AGroups
AModuleAccess
AFunctions
ARoles

Member Function Documentation

GetPermissions()

string Ict.Petra.Shared.Security.TPetraPrincipal.GetPermissions ( )

inline

diagnostic string to show which modules a user has been given access to (separated by newlines)

Returns

string permissions

IsInGroup()

Boolean Ict.Petra.Shared.Security.TPetraPrincipal.IsInGroup ( string  AGroupName )

inline

tells if the user is part of the given group

Parameters

AGroupName

Returns

IsInLedger()

Boolean Ict.Petra.Shared.Security.TPetraPrincipal.IsInLedger ( Int32  ALedgerNumber )

inline

Check if user can access this ledger

Parameters

ALedgerNumber

Returns

IsInModule()

Boolean Ict.Petra.Shared.Security.TPetraPrincipal.IsInModule ( string  AModuleName )

inline

check if user has access to the given module

Parameters

AModuleName

Returns

IsInRole()

Boolean Ict.Petra.Shared.Security.TPetraPrincipal.IsInRole ( string  ARoleName )

inline

tells if the user has the given role

Parameters

ARoleName

Returns

Property Documentation

Groups

string [] Ict.Petra.Shared.Security.TPetraPrincipal.Groups

getset

we need this for JSON serialization for the session

LoginMessage

String Ict.Petra.Shared.Security.TPetraPrincipal.LoginMessage

getset

login message can give system information to the user during login

ModuleAccess

string [] Ict.Petra.Shared.Security.TPetraPrincipal.ModuleAccess

getset

we need this for JSON serialization for the session

PartnerKey

Int64 Ict.Petra.Shared.Security.TPetraPrincipal.PartnerKey

getset

the partner key of this user

ProcessID

Int32 Ict.Petra.Shared.Security.TPetraPrincipal.ProcessID

getset

process id of the client domain on the server??? todoComment

UserID

String Ict.Petra.Shared.Security.TPetraPrincipal.UserID

getset

the current user id

---

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

• csharp/ICT/Petra/Shared/Security.Principal.cs