417 lines
21 KiB
C#

//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012 All Rights Reserved.
//
// File: CIM_AssociatedPrivilege.cs
//
// Contents: CIM_AssociatedPrivilege is an association that models the privileges that a Subject element has to access or authorize other elements to access a Target element.
// This file was automatically generated from CIM_AssociatedPrivilege.mof
//
//----------------------------------------------------------------------------
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Text;
using System.Globalization;
using System.Xml.Serialization;
using System.IO;
using Intel.Manageability.WSManagement;
using Intel.Manageability.Cim.Untyped;
namespace Intel.Manageability.Cim.Typed
{
/// <summary>
///CIM_AssociatedPrivilege is an association that models the privileges that a Subject element has to access or authorize other elements to access a Target element.
/// </summary>
[System.SerializableAttribute()]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_AssociatedPrivilege")]
[System.Xml.Serialization.XmlRootAttribute("CIM_AssociatedPrivilege", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_AssociatedPrivilege", IsNullable=false)]
public class CIM_AssociatedPrivilege : CimBase
{
/// <summary>
/// Default constructor.
/// </summary>
public CIM_AssociatedPrivilege() :base()
{
}
/// <summary>
/// Constructor that recieves an xml string for deserialization.
/// </summary>
/// <param name="xml">xml string to deserialize</param>
public CIM_AssociatedPrivilege(string xml): base((IWSManClient)null)
{
this.Deserialize(xml);
}
/// <summary>
/// Constructor which recieves a Ws-Management client object.
/// </summary>
/// <param name="client">Ws-Management client</param>
public CIM_AssociatedPrivilege(IWSManClient client): base(client)
{
}
/// <summary>
/// Remove Activities field.
/// Note: This method will succeed only if this field is optional in the concrete object.
/// </summary>
public virtual void RemoveActivities()
{
RemoveField("Activities");
}
/// <summary>
/// Is true if the field Activities exists in the current object,
/// otherwise is false.
/// </summary>
public virtual bool ActivitiesExist
{
get
{
return ContainsField("Activities");
}
}
/// <summary>
/// Optional, An enumeration indicating the activities that are granted or denied. These activities apply to all entities specified in the ActivityQualifiers array.
/// "Other" (1): indicates an activity that is not specified in this enumeration.
/// "Create" (2), "Delete" (3), "Detect" (4), "Read" (5), "Write" (6), "Execute" (7): each of these values indicates that the Subject is permitted to use an operation supported by the Target. They are all straightforward except for one, 4="Detect". This value indicates that the existence or presence of an entity may be determined, but not necessarily specific data (which requires the Read privilege to be true). This activity is exemplified by 'hidden files'- if you list the contents of a directory, you will not see hidden files. However, if you know a specific file name, or know how to expose hidden files, then they can be 'detected'. Another example is the ability to define search privileges in directory implementations.
/// "Deny Create" (8), "Deny Delete" (9), "Deny Detect" (10), "Deny Read" (11), "Deny Write" (12), "Deny Execute" (13): each of these values indicates that the Subject is expressly denied permission to use an operation supported by the Target.
/// Authorize to Grant/Deny Authorization (14): this value indicates that the Subject is permitted to add any of the following values to - or remove any of the following values from - the Activities array property in any other instance of CIM_AssociatedPrivilege that references the same Target: "Authorize to Create" (15), "Authorize to Delete" (16), "Authorize to Detect" (17), "Authorize to Read" (18), "Authorize to Write" (19), "Authorize to Execute" (20), "Authorize to Deny Create" (21), "Authorize to Deny Delete" (22), "Authorize to Deny Detect" (23), "Authorize to Deny Read" (24), "Authorize to Deny Write" (25), and "Authorize to Deny Execute" (26).
/// "Authorize to Create" (15), "Authorize to Delete" (16), "Authorize to Detect" (17), "Authorize to Read" (18), "Authorize to Write" (19), "Authorize to Execute" (20), "Authorize to Deny Create" (21), "Authorize to Deny Delete" (22), "Authorize to Deny Detect" (23), "Authorize to Deny Read" (24), "Authorize to Deny Write" (25), and "Authorize to Deny Execute" (26): each of these values indicates that the Subject is permitted to add value named in the string to - or remove the value from - the Activities array property in any other instance of CIM_AssociatedPrivilege that references the same Target. For example, "Authorize to Read" indicates that the Subject is permitted to add or remove the value "Read", and "Authorize to Deny Read" indicates that the Subject is permitted to add or remove the value "Deny Read".
/// </summary>
[CimField(false, false)]
public virtual ushort[] Activities
{
get
{
return CimTypesUtils.StringArrayToArray<ushort>(this["Activities"]);
}
set
{
string[] arr = CimTypesUtils.ArrayToStringArray<ushort>(value);
this.SetOrAddField("Activities", arr);
}
}
/// <summary>
/// Remove ActivityQualifiers field.
/// Note: This method will succeed only if this field is optional in the concrete object.
/// </summary>
public virtual void RemoveActivityQualifiers()
{
RemoveField("ActivityQualifiers");
}
/// <summary>
/// Is true if the field ActivityQualifiers exists in the current object,
/// otherwise is false.
/// </summary>
public virtual bool ActivityQualifiersExist
{
get
{
return ContainsField("ActivityQualifiers");
}
}
/// <summary>
/// Optional, The ActivityQualifiers property is an array of string values used to further qualify and specify the privileges granted or denied. For example, it is used to specify a set of files for which 'Read'/'Write' access is permitted or denied. Or, it defines a class' methods that may be 'Executed'. Details on the semantics of the individual entries in ActivityQualifiers are provided by corresponding entries in the QualifierFormats array.
/// </summary>
[CimField(false, false)]
public virtual string[] ActivityQualifiers
{
get
{
return CimTypesUtils.StringArrayToArray<string>(this["ActivityQualifiers"]);
}
set
{
string[] arr = CimTypesUtils.ArrayToStringArray<string>(value);
this.SetOrAddField("ActivityQualifiers", arr);
}
}
/// <summary>
/// Remove PrivilegeGranted field.
/// Note: This method will succeed only if this field is optional in the concrete object.
/// </summary>
public virtual void RemovePrivilegeGranted()
{
RemoveField("PrivilegeGranted");
}
/// <summary>
/// Is true if the field PrivilegeGranted exists in the current object,
/// otherwise is false.
/// </summary>
public virtual bool PrivilegeGrantedExist
{
get
{
return ContainsField("PrivilegeGranted");
}
}
/// <summary>
/// Optional, Boolean indicating whether the Privilege is granted (TRUE) or denied (FALSE). The default is to grant permission.
/// </summary>
[CimField(false, false)]
public virtual bool PrivilegeGranted
{
get
{
return bool.Parse(this["PrivilegeGranted"][0]);
}
set
{
this.SetOrAddField("PrivilegeGranted",value.ToString().ToLower(CultureInfo.InvariantCulture));
}
}
/// <summary>
/// Remove QualifierFormats field.
/// Note: This method will succeed only if this field is optional in the concrete object.
/// </summary>
public virtual void RemoveQualifierFormats()
{
RemoveField("QualifierFormats");
}
/// <summary>
/// Is true if the field QualifierFormats exists in the current object,
/// otherwise is false.
/// </summary>
public virtual bool QualifierFormatsExist
{
get
{
return ContainsField("QualifierFormats");
}
}
/// <summary>
/// Optional, Defines the semantics of corresponding entries in the ActivityQualifiers array. An example of each of these 'formats' and their use follows:
/// - 2=Class Name. Example: If the authorization target is a CIM Service or a Namespace, then the ActivityQualifiers entries can define a list of classes that the authorized subject is able to create or delete.
/// - 3=&lt;Class.&gt;Property. Example: If the authorization target is a CIM Service, Namespace or Collection of instances, then the ActivityQualifiers entries can define the class properties that may or may not be accessed. In this case, the class names are specified with the property names to avoid ambiguity - since a CIM Service, Namespace or Collection could manage multiple classes. On the other hand, if the authorization target is an individual instance, then there is no possible ambiguity and the class name may be omitted. To specify ALL properties, the wildcard string "*" should be used.
/// - 4=&lt;Class.&gt;Method. This example is very similar to the Property one, above. And, as above, the string "*" may be specified to select ALL methods.
/// - 5=Object Reference. Example: If the authorization target is a CIM Service or Namespace, then the ActivityQualifiers entries can define a list of object references (as strings) that the authorized subject can access.
/// - 6=Namespace. Example: If the authorization target is a CIM Service, then the ActivityQualifiers entries can define a list of Namespaces that the authorized subject is able to access.
/// - 7=URL. Example: An authorization target may not be defined, but a Privilege could be used to deny access to specific URLs by individual Identities or for specific Roles, such as the 'under 17' Role.
/// - 8=Directory/File Name. Example: If the authorization target is a FileSystem, then the ActivityQualifiers entries can define a list of directories and files whose access is protected.
/// - 9=Command Line Instruction. Example: If the authorization target is a ComputerSystem or Service, then the ActivityQualifiers entries can define a list of command line instructions that may or may not be 'Executed' by the authorized subjects.
/// - 10=SCSI Command, using a format of 'CDB=xx[,Page=pp]'. For example, the ability to select the VPD page of the Inquiry command is encoded as 'CDB=12,Page=83' in the corresponding ActivityQualifiers entry. A '*' may be used to indicate all CDBs or Page numbers.
/// - 11=Packets. Example: The transmission of packets is permitted or denied by the Privilege for the target (a ComputerSystem, ProtocolEndpoint, Pipe, or other ManagedSystemElement).
/// - 12=Specification-defined. The semantics are defined in a a specification produced by the DMTF or other organization. The value of the corresponding ActivityQualifiers entry names the specification and the organization that produced it, and includes a label that unambiguously references the semantic definition within the specification. The value of of the corresponding ActivityQualifiers entry should be constructed using the following "preferred" algorithm:
/// &lt;OrgID&gt;:&lt;SpecID&gt;:&lt;Label&gt;, where &lt;OrgID&gt;, &lt;SpecID&gt;, and &lt;Label&gt; are separated by a colon (:), and where &lt;OrgID&gt; shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the &lt;Schema Name&gt;_&lt;Class Name&gt; structure of Schema class names.) In addition, to ensure uniqueness both &lt;OrgID&gt; and &lt;SpecID&gt; shall not contain a colon (':'). When using this algorithm, the first colon to appear in the corresponding ActivityQualifiers entry shall appear between &lt;OrgID&gt; and &lt;SpecID&gt; and the second colon to appear in the corresponding ActivityQualifiers entry shall appear between &lt;SpecID&gt; and &lt;Label&gt;.
/// &lt;Label&gt; is chosen by the business entity and should not be reused to identify different underlying semantics. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting value is not reused to refer to a different specification or different semantics within defined within the same specification.
/// For DMTF-defined instances, the "preferred" algorithm shall be used with the &lt;OrgID&gt; set to "DMTF", and the &lt;SpecID&gt; set to "DSPx", where x is the number of a DSP published by the DMTF.
/// </summary>
[CimField(false, false)]
public virtual ushort[] QualifierFormats
{
get
{
return CimTypesUtils.StringArrayToArray<ushort>(this["QualifierFormats"]);
}
set
{
string[] arr = CimTypesUtils.ArrayToStringArray<ushort>(value);
this.SetOrAddField("QualifierFormats", arr);
}
}
/// <summary>
/// Remove RepresentsAuthorizationRights field.
/// Note: This method will succeed only if this field is optional in the concrete object.
/// </summary>
public virtual void RemoveRepresentsAuthorizationRights()
{
RemoveField("RepresentsAuthorizationRights");
}
/// <summary>
/// Is true if the field RepresentsAuthorizationRights exists in the current object,
/// otherwise is false.
/// </summary>
public virtual bool RepresentsAuthorizationRightsExist
{
get
{
return ContainsField("RepresentsAuthorizationRights");
}
}
/// <summary>
/// Optional, The RepresentsAuthorizationRights flag indicates whether the rights defined by this instance shall be interpreted as rights of Subjects to access Targets or as rights of Subjects to change those rights on/for Targets.
/// </summary>
[CimField(false, false)]
public virtual bool RepresentsAuthorizationRights
{
get
{
return bool.Parse(this["RepresentsAuthorizationRights"][0]);
}
set
{
this.SetOrAddField("RepresentsAuthorizationRights",value.ToString().ToLower(CultureInfo.InvariantCulture));
}
}
/// <summary>
/// Key, Required, The Subject for which privileges are granted or denied.
/// </summary>
[CimField(true, false)]
public virtual CimReference Subject
{
get
{
string innerXML = this.GetField("Subject")[0];
CimReference epr = new CimReference("Subject", XmlNamespace, innerXML);
return epr;
}
set
{
this.SetOrAddField("Subject",value.Serialize(false));
}
}
/// <summary>
/// Key, Required, The target element to which the privileges apply.
/// </summary>
[CimField(true, false)]
public virtual CimReference Target
{
get
{
string innerXML = this.GetField("Target")[0];
CimReference epr = new CimReference("Target", XmlNamespace, innerXML);
return epr;
}
set
{
this.SetOrAddField("Target",value.Serialize(false));
}
}
/// <summary>
/// Key, Required, UseKey is used to distinguish instances in case multiple instances of this association exist between the same Subject and Target. This may arise, for example, if separate instances are created for each management domain, or if the Subject has access and authorization rights to the Target.
/// Within the scope of the instantiating Namespace, UseKey opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of UseKey should be constructed using the following 'preferred' algorithm:
/// &lt;OrgID&gt;:&lt;LocalID&gt;
/// Where &lt;OrgID&gt; and &lt;LocalID&gt; are separated by a colon ':', and where &lt;OrgID&gt; shall include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the UseKey, or is a registered ID that is assigned to the business entity by a recognized global authority. (This is similar to the &lt;Schema Name&gt;_&lt;Class Name&gt; structure of Schema class names.) In addition, to ensure uniqueness &lt;OrgID&gt; shall not contain a colon (':'). When using this algorithm, the first colon to appear in UseKey shall appear between &lt;OrgID&gt; and &lt;LocalID&gt;.
/// &lt;LocalID&gt; is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity shall assure that the resultant UseKey is not re-used across any UseKeys produced by this or other providers for this instance's NameSpace.
/// For DMTF defined instances, the 'preferred' algorithm shall be used with the &lt;OrgID&gt; set to 'CIM'.
/// </summary>
[CimField(true, true)]
public virtual string UseKey
{
get
{
return this.GetField("UseKey")[0];
}
set
{
this.SetOrAddField("UseKey",value);
}
}
/// <summary>
/// Enumerate instances of CIM_AssociatedPrivilege class at an endpoint.
/// </summary>
/// <param name="client">WS-Management client</param>
/// <param name="cimKeys">Keys for selecting the instances</param>
/// <returns>Collection of CIM_AssociatedPrivilege objects</returns>
public static Collection<CIM_AssociatedPrivilege> Enumerate(IWSManClient client, CimBase.CimKeys cimKeys)
{
List<CIM_AssociatedPrivilege> ret = CimBase.Enumerate<CIM_AssociatedPrivilege>(client, cimKeys);
return new Collection<CIM_AssociatedPrivilege>(ret);
}
/// <summary>
/// Enumerate instances of CIM_AssociatedPrivilege class at an endpoint.
/// </summary>
/// <param name="client">WS-Management client</param>
/// <returns>Collection of CIM_AssociatedPrivilege objects</returns>
public static Collection<CIM_AssociatedPrivilege> Enumerate(IWSManClient client)
{
List<CIM_AssociatedPrivilege> ret = CimBase.Enumerate<CIM_AssociatedPrivilege>(client);
return new Collection<CIM_AssociatedPrivilege>(ret);
}
/// <summary>
/// Delete the instance of CIM_AssociatedPrivilege if it is singular.
/// Note: This method will succeed only if a single instance of the class exists.
/// </summary>
/// <param name="client">WS-Management client</param>
public static void Delete(IWSManClient client)
{
CimBase.Delete<CIM_AssociatedPrivilege>(client);
}
/// <summary>
/// Represents the keys of the CIM_AssociatedPrivilege class.
/// </summary>
public new class CimKeys : CimBase.CimKeys
{
/// <summary>
/// Key, Required, The Subject for which privileges are granted or denied.
/// </summary>
public virtual CimReference Subject
{
get
{
string innerXML = GetKey("Subject");
CimReference epr = new CimReference("Subject", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_AssociatedPrivilege", innerXML);
return epr;
}
set
{
SetOrAddKey("Subject", value);
}
}
/// <summary>
/// Key, Required, The target element to which the privileges apply.
/// </summary>
public virtual CimReference Target
{
get
{
string innerXML = GetKey("Target");
CimReference epr = new CimReference("Target", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_AssociatedPrivilege", innerXML);
return epr;
}
set
{
SetOrAddKey("Target", value);
}
}
/// <summary>
/// Key, Required, UseKey is used to distinguish instances in case multiple instances of this association exist between the same Subject and Target. This may arise, for example, if separate instances are created for each management domain, or if the Subject has access and authorization rights to the Target.
/// Within the scope of the instantiating Namespace, UseKey opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of UseKey should be constructed using the following 'preferred' algorithm:
/// &lt;OrgID&gt;:&lt;LocalID&gt;
/// Where &lt;OrgID&gt; and &lt;LocalID&gt; are separated by a colon ':', and where &lt;OrgID&gt; shall include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the UseKey, or is a registered ID that is assigned to the business entity by a recognized global authority. (This is similar to the &lt;Schema Name&gt;_&lt;Class Name&gt; structure of Schema class names.) In addition, to ensure uniqueness &lt;OrgID&gt; shall not contain a colon (':'). When using this algorithm, the first colon to appear in UseKey shall appear between &lt;OrgID&gt; and &lt;LocalID&gt;.
/// &lt;LocalID&gt; is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity shall assure that the resultant UseKey is not re-used across any UseKeys produced by this or other providers for this instance's NameSpace.
/// For DMTF defined instances, the 'preferred' algorithm shall be used with the &lt;OrgID&gt; set to 'CIM'.
/// </summary>
public virtual string UseKey
{
get
{
return GetKey("UseKey");
}
set
{
SetOrAddKey("UseKey", value);
}
}
}
}
}