Click or drag to resize
OSIsoft, LLC

AFSecurityMappings Class

The AFSecurityMappings collection represents the available AFSecurityMapping objects on a particular PISystem (PI AF Server).

Inheritance Hierarchy
SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionAFSecurityMapping
      OSIsoft.AFAFNamedCollectionAFSecurityMapping
        OSIsoft.AFAFSecurityMappings

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
public class AFSecurityMappings : AFNamedCollection<AFSecurityMapping>

The AFSecurityMappings type exposes the following members.

Properties
  NameDescription
Public propertyCount
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.)
Public propertyIdentity
This read-only property contains identity of the object.
(Inherited from AFCollection.)
Public propertyIsDeleted
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.)
Public propertyItemGuid
Returns the item in the collection associated with the passed in ID.
(Inherited from AFCollectionT.)
Public propertyItemInt32
Returns the item located at the passed in index.
(Inherited from AFCollectionT.)
Public propertyItemString
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.)
Public propertyItemIdentity
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.)
Public propertyPISystem
This read-only property allows access to the PISystem associated with this collection.
(Inherited from AFCollection.)
Top
Methods
  NameDescription
Public methodAdd(T)
Adds an object to the end of the collection.
(Inherited from AFCollectionT.)
Public methodAdd(String, NTAccount, AFSecurityIdentity, String)
The Add method creates a new AFSecurityMapping from the specified NTAccount to a AFSecurityIdentity and adds it to the collection.
Public methodClear
Removes all items from the collection.
(Inherited from AFCollectionT.)
Public methodContains(Guid)
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.)
Public methodContains(T)
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.)
Public methodContains(String)
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.)
Public methodCopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from AFCollectionT.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.)
Public methodGetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from AFCollection.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
(Inherited from AFCollectionT.)
Public methodInsert
Inserts an item into the collection at the specified index.
Public methodRefresh
Refresh the collection to make sure it's list of items is up-to-date.
Public methodRemove(Guid)
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.)
Public methodRemove(T)
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.)
Public methodRemove(String)
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.)
Public methodRemoveAt
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.)
Public methodSort
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.)
Public methodSort(IComparerT)
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.)
Public methodSort(Int32, Int32, IComparerT)
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.)
Public methodToString
Returns a String that represents the current object.
(Inherited from AFCollection.)
Top
Remarks
This is the collection of available AFSecurityMapping objects on a particular PISystem (PI AF Server). Each AFSecurityMapping object provides the mapping from Windows user or group to a AFSecurityIdentity on the PI AF Server.
Examples
// This example shows how to create and configure Security Identities
// and Security Mappings.

// Get the PISystem
PISystems myPISystems = new PISystems();
PISystem myPISystem = myPISystems.DefaultPISystem;

// Add a new Security Identity
AFSecurityIdentity myIdentity = myPISystem.SecurityIdentities.Add("MyTestUser");
myIdentity.Description = "Test User Identity";
myIdentity.CheckIn();

// Add a new Security Mapping for current user to the new Security Identity
AFSecurityMapping myMapping1 = myPISystem.SecurityMappings.Add(null, null, myIdentity);
myMapping1.Description = "Current User Mapping";

// Add a new Security Mapping for a different account to the new Security Identity
NTAccount account = new NTAccount(@"Guest");
AFSecurityMapping myMapping2 = myPISystem.SecurityMappings.Add("MyGuest", account, myIdentity);
myMapping2.Description = "My Guest Mapping";
myPISystem.CheckIn();

// Display each Security Mapping
int securityMappingCount = myPISystem.SecurityMappings.Count;
Console.WriteLine("Security Mapping Count = {0}", securityMappingCount);
foreach (AFSecurityMapping CurMapping in myPISystem.SecurityMappings)
{
    Console.WriteLine("  Name = {0}", CurMapping.Name);
    Console.WriteLine("  Description = {0}", CurMapping.Description);
    Console.WriteLine("  Account = {0}", CurMapping.Account);
}

// Display each Security Identity
int securityIdentityCount = myPISystem.SecurityIdentities.Count;
Console.WriteLine("Security Identity Count = {0}", securityIdentityCount);
foreach (AFSecurityIdentity CurIdentity in myPISystem.SecurityIdentities)
{
    Console.WriteLine("  Name = {0}", CurIdentity.Name);
    Console.WriteLine("  Description = {0}", CurIdentity.Description);
}

// Remove the new Security Identity which will remove the new Security Mappings.
myPISystem.SecurityIdentities.Remove(myIdentity);
myPISystem.CheckIn();
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7
See Also
Enabling Operational Intelligence