AFSecurity.CheckSecurity Method (PISystem, IList(AFSecurityIdentity), IList(AFSecurityRightsToken), String)

Public Shared Function CheckSecurity ( 
	system As PISystem,
	userIdentities As IList(Of AFSecurityIdentity),
	tokens As IList(Of AFSecurityRightsToken),
	Optional userName As String = Nothing
) As IDictionary(Of Guid, AFSecurityRights)

Dim system As PISystem
Dim userIdentities As IList(Of AFSecurityIdentity)
Dim tokens As IList(Of AFSecurityRightsToken)
Dim userName As String
Dim returnValue As IDictionary(Of Guid, AFSecurityRights)

returnValue = AFSecurity.CheckSecurity(system, 
	userIdentities, tokens, userName)

public:
static IDictionary<Guid, AFSecurityRights>^ CheckSecurity(
	PISystem^ system, 
	IList<AFSecurityIdentity^>^ userIdentities, 
	IList<AFSecurityRightsToken>^ tokens, 
	String^ userName = nullptr
)

static member CheckSecurity : 
        system : PISystem * 
        userIdentities : IList<AFSecurityIdentity> * 
        tokens : IList<AFSecurityRightsToken> * 
        ?userName : string 
(* Defaults:
        let _userName = defaultArg userName null
*)
-> IDictionary<Guid, AFSecurityRights> 

' Get the Database
Dim myPISystems As New PISystems
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
Dim myDB As AFDatabase = myPISystem.Databases.DefaultDatabase

' Create the Elements
Dim elements As New List(Of AFElement)()
Dim myElement1 As AFElement = myDB.Elements.Add("MyElement#1")
myElement1.CheckIn()
elements.Add(myElement1)
Dim myElement2 As AFElement = myDB.Elements.Add("MyElement#2")
myElement2.CheckIn()
elements.Add(myElement2)

' Obtain the WindowsIdentity of an impersonated user. This
'   can be done with the following code if the current thread
'   has impersonated a user.
'  Dim user As WindowsIdentity = WindowsIdentity.GetCurrent()
' Obtain the WindowsIdentity of a different domain user. This
'   can be done with the following code.
'  Dim user As WindowsIdentity = New WindowsIdentity("username@domain")
Dim userName As String = "domain\username"
Dim userIdentities As IList(Of AFSecurityIdentity)
Using user As WindowsIdentity = windowsIdentityOfADifferentUser
    ' Get Security Identities of a Different User
    userName = user.Name
    userIdentities = AFSecurity.GetUserIdentities(myPISystem, user)
End Using

' Check Security Rights of a Different User
Dim security1 As AFSecurity = myElement1.Security
Dim rights As AFSecurityRights = security1.CheckSecurity(userIdentities, userName)
Console.WriteLine("SecurityRights for '{0}': '{1}'", myElement1.Name, rights)
Console.WriteLine("    CanRead={0}", rights.CanRead())
Console.WriteLine("    CanWrite={0}", rights.CanWrite())
Console.WriteLine()

' Check Security Rights of a Different User in Bulk
Dim tokens As New List(Of AFSecurityRightsToken)()
tokens.Add(security1.Token)
tokens.Add(myElement2.Security.Token)
Dim rightsDict As IDictionary(Of Guid, AFSecurityRights) =
AFSecurity.CheckSecurity(myPISystem, userIdentities, tokens, userName)
Dim notFoundCount As Integer = 0
For Each element As AFElement In elements
    If rightsDict.TryGetValue(element.ID, rights) Then
        Console.WriteLine("SecurityRights for '{0}': '{1}'", element.Name, rights)
        Console.WriteLine("    CanRead={0}", rights.CanRead())
        Console.WriteLine("    CanWrite={0}", rights.CanWrite())
        Console.WriteLine()
    Else
        notFoundCount += 1
    End If
Next

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

' Get the Database
Dim myPISystems As New PISystems()
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
If myPISystem Is Nothing Then
    Throw New InvalidOperationException("Default PISystem was not found.")
End If
Dim myDB As AFDatabase = myPISystem.Databases(dbName)
If myDB Is Nothing Then
    Throw New InvalidOperationException("Database was not found.")
End If

' Create a search to find all the event frames created from the 'Event'
' template and its 'Level' attribute value is less than 90.
Dim count As Integer
Using search As New AFEventFrameSearch(myDB, "FindEventFields", "Template:'Event' |Level:<90.0")

    search.CacheTimeout = TimeSpan.FromMinutes(10)

    ' Do the search

    ' Return event frame security tokens as list and check security for current user.
    count = 0
    Dim foundItems4 = search.FindObjectFields("SecurityToken", Function(i) CType(i(0), AFSecurityRightsToken))
    Console.WriteLine("Find Object SecurityTokens and Check Security:")
    For Each tokenList In foundItems4.ChunkedBy(500)
        ' Check Security using Windows Identity.
        Dim rights = AFSecurity.CheckSecurity(myPISystem, WindowsIdentity.GetCurrent, tokenList)
        For Each rightsItem In rights
            Console.WriteLine($"  Security Rights for '{myPISystem.CurrentUserName}': {rightsItem.Key} = {rightsItem.Value}")
        Next

        ' Check Security using Identities.
        rights = AFSecurity.CheckSecurity(myPISystem, myPISystem.CurrentUserIdentities, tokenList, myPISystem.CurrentUserName)
        For Each rightsItem In rights
            Console.WriteLine($"  Security Rights for '{myPISystem.CurrentUserIdentityString}': {rightsItem.Key} = {rightsItem.Value}")
        Next
        count = (count + tokenList.Count)
    Next
    Console.WriteLine("Found {0} EventFrames.", count)

End Using

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.