/* * Copyright (c) Citrix Systems, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1) Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2) Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials * provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. */ using System; using System.Collections; using System.Collections.Generic; using System.ComponentModel; using System.Globalization; using Newtonsoft.Json; using Newtonsoft.Json.Converters; namespace XenAPI { /// /// A user or group that can log in xapi /// First published in XenServer 5.5. /// public partial class Subject : XenObject { public Subject() { } public Subject(string uuid, string subject_identifier, Dictionary other_config, List> roles) { this.uuid = uuid; this.subject_identifier = subject_identifier; this.other_config = other_config; this.roles = roles; } /// /// Creates a new Subject from a Proxy_Subject. /// /// public Subject(Proxy_Subject proxy) { this.UpdateFromProxy(proxy); } /// /// Updates each field of this instance with the value of /// the corresponding field of a given Subject. /// public override void UpdateFrom(Subject update) { uuid = update.uuid; subject_identifier = update.subject_identifier; other_config = update.other_config; roles = update.roles; } internal void UpdateFromProxy(Proxy_Subject proxy) { uuid = proxy.uuid == null ? null : (string)proxy.uuid; subject_identifier = proxy.subject_identifier == null ? null : (string)proxy.subject_identifier; other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); roles = proxy.roles == null ? null : XenRef.Create(proxy.roles); } public Proxy_Subject ToProxy() { Proxy_Subject result_ = new Proxy_Subject(); result_.uuid = uuid ?? ""; result_.subject_identifier = subject_identifier ?? ""; result_.other_config = Maps.convert_to_proxy_string_string(other_config); result_.roles = (roles != null) ? Helper.RefListToStringArray(roles) : new string[] {}; return result_; } /// /// Creates a new Subject from a Hashtable. /// Note that the fields not contained in the Hashtable /// will be created with their default values. /// /// public Subject(Hashtable table) : this() { UpdateFrom(table); } /// /// Given a Hashtable with field-value pairs, it updates the fields of this Subject /// with the values listed in the Hashtable. Note that only the fields contained /// in the Hashtable will be updated and the rest will remain the same. /// /// public void UpdateFrom(Hashtable table) { if (table.ContainsKey("uuid")) uuid = (string)table["uuid"]; if (table.ContainsKey("subject_identifier")) subject_identifier = (string)table["subject_identifier"]; if (table.ContainsKey("other_config")) other_config = Maps.convert_from_proxy_string_string((Hashtable)table["other_config"]); if (table.ContainsKey("roles")) roles = XenRef.Create((object[])table["roles"]); } public bool DeepEquals(Subject other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._subject_identifier, other._subject_identifier) && Helper.AreEqual2(this._other_config, other._other_config) && Helper.AreEqual2(this._roles, other._roles); } internal static List ProxyArrayToObjectList(Proxy_Subject[] input) { var result = new List(); foreach (var item in input) result.Add(new Subject(item)); return result; } public override string SaveChanges(Session session, string opaqueRef, Subject server) { if (opaqueRef == null) { var reference = create(session, this); return reference == null ? null : reference.opaque_ref; } else { throw new InvalidOperationException("This type has no read/write properties"); } } /// /// Get a record containing the current state of the given subject. /// First published in XenServer 5.5. /// /// The session /// The opaque_ref of the given subject public static Subject get_record(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_record(session.uuid, _subject); else return new Subject((Proxy_Subject)session.proxy.subject_get_record(session.uuid, _subject ?? "").parse()); } /// /// Get a reference to the subject instance with the specified UUID. /// First published in XenServer 5.5. /// /// The session /// UUID of object to return public static XenRef get_by_uuid(Session session, string _uuid) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_by_uuid(session.uuid, _uuid); else return XenRef.Create(session.proxy.subject_get_by_uuid(session.uuid, _uuid ?? "").parse()); } /// /// Create a new subject instance, and return its handle. /// First published in XenServer 5.5. /// /// The session /// All constructor arguments public static XenRef create(Session session, Subject _record) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_create(session.uuid, _record); else return XenRef.Create(session.proxy.subject_create(session.uuid, _record.ToProxy()).parse()); } /// /// Create a new subject instance, and return its handle. /// First published in XenServer 5.5. /// /// The session /// All constructor arguments public static XenRef async_create(Session session, Subject _record) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_subject_create(session.uuid, _record); else return XenRef.Create(session.proxy.async_subject_create(session.uuid, _record.ToProxy()).parse()); } /// /// Destroy the specified subject instance. /// First published in XenServer 5.5. /// /// The session /// The opaque_ref of the given subject public static void destroy(Session session, string _subject) { if (session.JsonRpcClient != null) session.JsonRpcClient.subject_destroy(session.uuid, _subject); else session.proxy.subject_destroy(session.uuid, _subject ?? "").parse(); } /// /// Destroy the specified subject instance. /// First published in XenServer 5.5. /// /// The session /// The opaque_ref of the given subject public static XenRef async_destroy(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_subject_destroy(session.uuid, _subject); else return XenRef.Create(session.proxy.async_subject_destroy(session.uuid, _subject ?? "").parse()); } /// /// Get the uuid field of the given subject. /// First published in XenServer 5.5. /// /// The session /// The opaque_ref of the given subject public static string get_uuid(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_uuid(session.uuid, _subject); else return (string)session.proxy.subject_get_uuid(session.uuid, _subject ?? "").parse(); } /// /// Get the subject_identifier field of the given subject. /// First published in XenServer 5.5. /// /// The session /// The opaque_ref of the given subject public static string get_subject_identifier(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_subject_identifier(session.uuid, _subject); else return (string)session.proxy.subject_get_subject_identifier(session.uuid, _subject ?? "").parse(); } /// /// Get the other_config field of the given subject. /// First published in XenServer 5.5. /// /// The session /// The opaque_ref of the given subject public static Dictionary get_other_config(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_other_config(session.uuid, _subject); else return Maps.convert_from_proxy_string_string(session.proxy.subject_get_other_config(session.uuid, _subject ?? "").parse()); } /// /// Get the roles field of the given subject. /// First published in XenServer 5.6. /// /// The session /// The opaque_ref of the given subject public static List> get_roles(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_roles(session.uuid, _subject); else return XenRef.Create(session.proxy.subject_get_roles(session.uuid, _subject ?? "").parse()); } /// /// This call adds a new role to a subject /// First published in XenServer 5.6. /// /// The session /// The opaque_ref of the given subject /// The unique role reference public static void add_to_roles(Session session, string _subject, string _role) { if (session.JsonRpcClient != null) session.JsonRpcClient.subject_add_to_roles(session.uuid, _subject, _role); else session.proxy.subject_add_to_roles(session.uuid, _subject ?? "", _role ?? "").parse(); } /// /// This call removes a role from a subject /// First published in XenServer 5.6. /// /// The session /// The opaque_ref of the given subject /// The unique role reference in the subject's roles field public static void remove_from_roles(Session session, string _subject, string _role) { if (session.JsonRpcClient != null) session.JsonRpcClient.subject_remove_from_roles(session.uuid, _subject, _role); else session.proxy.subject_remove_from_roles(session.uuid, _subject ?? "", _role ?? "").parse(); } /// /// This call returns a list of permission names given a subject /// First published in XenServer 5.6. /// /// The session /// The opaque_ref of the given subject public static string[] get_permissions_name_label(Session session, string _subject) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_permissions_name_label(session.uuid, _subject); else return (string [])session.proxy.subject_get_permissions_name_label(session.uuid, _subject ?? "").parse(); } /// /// Return a list of all the subjects known to the system. /// First published in XenServer 5.5. /// /// The session public static List> get_all(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_all(session.uuid); else return XenRef.Create(session.proxy.subject_get_all(session.uuid).parse()); } /// /// Get all the subject Records at once, in a single XML RPC call /// First published in XenServer 5.5. /// /// The session public static Dictionary, Subject> get_all_records(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.subject_get_all_records(session.uuid); else return XenRef.Create(session.proxy.subject_get_all_records(session.uuid).parse()); } /// /// Unique identifier/object reference /// public virtual string uuid { get { return _uuid; } set { if (!Helper.AreEqual(value, _uuid)) { _uuid = value; Changed = true; NotifyPropertyChanged("uuid"); } } } private string _uuid = ""; /// /// the subject identifier, unique in the external directory service /// public virtual string subject_identifier { get { return _subject_identifier; } set { if (!Helper.AreEqual(value, _subject_identifier)) { _subject_identifier = value; Changed = true; NotifyPropertyChanged("subject_identifier"); } } } private string _subject_identifier = ""; /// /// additional configuration /// public virtual Dictionary other_config { get { return _other_config; } set { if (!Helper.AreEqual(value, _other_config)) { _other_config = value; Changed = true; NotifyPropertyChanged("other_config"); } } } private Dictionary _other_config = new Dictionary() {}; /// /// the roles associated with this subject /// First published in XenServer 5.6. /// [JsonConverter(typeof(XenRefListConverter))] public virtual List> roles { get { return _roles; } set { if (!Helper.AreEqual(value, _roles)) { _roles = value; Changed = true; NotifyPropertyChanged("roles"); } } } private List> _roles = new List>() {new XenRef("OpaqueRef:0165f154-ba3e-034e-6b27-5d271af109ba")}; } }