/* * 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; namespace XenAPI { /// /// Represents a patch stored on a server /// First published in XenServer 4.0. /// public partial class Host_patch : XenObject { #region Constructors public Host_patch() { } public Host_patch(string uuid, string name_label, string name_description, string version, XenRef host, bool applied, DateTime timestamp_applied, long size, XenRef pool_patch, Dictionary other_config) { this.uuid = uuid; this.name_label = name_label; this.name_description = name_description; this.version = version; this.host = host; this.applied = applied; this.timestamp_applied = timestamp_applied; this.size = size; this.pool_patch = pool_patch; this.other_config = other_config; } /// /// Creates a new Host_patch from a Hashtable. /// Note that the fields not contained in the Hashtable /// will be created with their default values. /// /// public Host_patch(Hashtable table) : this() { UpdateFrom(table); } /// /// Creates a new Host_patch from a Proxy_Host_patch. /// /// public Host_patch(Proxy_Host_patch proxy) { UpdateFrom(proxy); } #endregion /// /// Updates each field of this instance with the value of /// the corresponding field of a given Host_patch. /// public override void UpdateFrom(Host_patch update) { uuid = update.uuid; name_label = update.name_label; name_description = update.name_description; version = update.version; host = update.host; applied = update.applied; timestamp_applied = update.timestamp_applied; size = update.size; pool_patch = update.pool_patch; other_config = update.other_config; } internal void UpdateFrom(Proxy_Host_patch proxy) { uuid = proxy.uuid == null ? null : proxy.uuid; name_label = proxy.name_label == null ? null : proxy.name_label; name_description = proxy.name_description == null ? null : proxy.name_description; version = proxy.version == null ? null : proxy.version; host = proxy.host == null ? null : XenRef.Create(proxy.host); applied = (bool)proxy.applied; timestamp_applied = proxy.timestamp_applied; size = proxy.size == null ? 0 : long.Parse(proxy.size); pool_patch = proxy.pool_patch == null ? null : XenRef.Create(proxy.pool_patch); other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); } public Proxy_Host_patch ToProxy() { Proxy_Host_patch result_ = new Proxy_Host_patch(); result_.uuid = uuid ?? ""; result_.name_label = name_label ?? ""; result_.name_description = name_description ?? ""; result_.version = version ?? ""; result_.host = host ?? ""; result_.applied = applied; result_.timestamp_applied = timestamp_applied; result_.size = size.ToString(); result_.pool_patch = pool_patch ?? ""; result_.other_config = Maps.convert_to_proxy_string_string(other_config); return result_; } /// /// Given a Hashtable with field-value pairs, it updates the fields of this Host_patch /// 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 = Marshalling.ParseString(table, "uuid"); if (table.ContainsKey("name_label")) name_label = Marshalling.ParseString(table, "name_label"); if (table.ContainsKey("name_description")) name_description = Marshalling.ParseString(table, "name_description"); if (table.ContainsKey("version")) version = Marshalling.ParseString(table, "version"); if (table.ContainsKey("host")) host = Marshalling.ParseRef(table, "host"); if (table.ContainsKey("applied")) applied = Marshalling.ParseBool(table, "applied"); if (table.ContainsKey("timestamp_applied")) timestamp_applied = Marshalling.ParseDateTime(table, "timestamp_applied"); if (table.ContainsKey("size")) size = Marshalling.ParseLong(table, "size"); if (table.ContainsKey("pool_patch")) pool_patch = Marshalling.ParseRef(table, "pool_patch"); if (table.ContainsKey("other_config")) other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config")); } public bool DeepEquals(Host_patch other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._name_label, other._name_label) && Helper.AreEqual2(this._name_description, other._name_description) && Helper.AreEqual2(this._version, other._version) && Helper.AreEqual2(this._host, other._host) && Helper.AreEqual2(this._applied, other._applied) && Helper.AreEqual2(this._timestamp_applied, other._timestamp_applied) && Helper.AreEqual2(this._size, other._size) && Helper.AreEqual2(this._pool_patch, other._pool_patch) && Helper.AreEqual2(this._other_config, other._other_config); } internal static List ProxyArrayToObjectList(Proxy_Host_patch[] input) { var result = new List(); foreach (var item in input) result.Add(new Host_patch(item)); return result; } public override string SaveChanges(Session session, string opaqueRef, Host_patch server) { if (opaqueRef == null) { System.Diagnostics.Debug.Assert(false, "Cannot create instances of this type on the server"); return ""; } else { if (!Helper.AreEqual2(_other_config, server._other_config)) { Host_patch.set_other_config(session, opaqueRef, _other_config); } return null; } } /// /// Get a record containing the current state of the given host_patch. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.1. /// /// The session /// The opaque_ref of the given host_patch [Deprecated("XenServer 7.1")] public static Host_patch get_record(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_record(session.opaque_ref, _host_patch); else return new Host_patch(session.XmlRpcProxy.host_patch_get_record(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Get a reference to the host_patch instance with the specified UUID. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.1. /// /// The session /// UUID of object to return [Deprecated("XenServer 7.1")] public static XenRef get_by_uuid(Session session, string _uuid) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_by_uuid(session.opaque_ref, _uuid); else return XenRef.Create(session.XmlRpcProxy.host_patch_get_by_uuid(session.opaque_ref, _uuid ?? "").parse()); } /// /// Get all the host_patch instances with the given label. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.1. /// /// The session /// label of object to return [Deprecated("XenServer 7.1")] public static List> get_by_name_label(Session session, string _label) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_by_name_label(session.opaque_ref, _label); else return XenRef.Create(session.XmlRpcProxy.host_patch_get_by_name_label(session.opaque_ref, _label ?? "").parse()); } /// /// Get the uuid field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static string get_uuid(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_uuid(session.opaque_ref, _host_patch); else return session.XmlRpcProxy.host_patch_get_uuid(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Get the name/label field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static string get_name_label(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_name_label(session.opaque_ref, _host_patch); else return session.XmlRpcProxy.host_patch_get_name_label(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Get the name/description field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static string get_name_description(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_name_description(session.opaque_ref, _host_patch); else return session.XmlRpcProxy.host_patch_get_name_description(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Get the version field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static string get_version(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_version(session.opaque_ref, _host_patch); else return session.XmlRpcProxy.host_patch_get_version(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Get the host field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static XenRef get_host(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_host(session.opaque_ref, _host_patch); else return XenRef.Create(session.XmlRpcProxy.host_patch_get_host(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Get the applied field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static bool get_applied(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_applied(session.opaque_ref, _host_patch); else return (bool)session.XmlRpcProxy.host_patch_get_applied(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Get the timestamp_applied field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static DateTime get_timestamp_applied(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_timestamp_applied(session.opaque_ref, _host_patch); else return session.XmlRpcProxy.host_patch_get_timestamp_applied(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Get the size field of the given host_patch. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given host_patch public static long get_size(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_size(session.opaque_ref, _host_patch); else return long.Parse(session.XmlRpcProxy.host_patch_get_size(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Get the pool_patch field of the given host_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch public static XenRef get_pool_patch(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_pool_patch(session.opaque_ref, _host_patch); else return XenRef.Create(session.XmlRpcProxy.host_patch_get_pool_patch(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Get the other_config field of the given host_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch public static Dictionary get_other_config(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_other_config(session.opaque_ref, _host_patch); else return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.host_patch_get_other_config(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Set the other_config field of the given host_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch /// New value to set public static void set_other_config(Session session, string _host_patch, Dictionary _other_config) { if (session.JsonRpcClient != null) session.JsonRpcClient.host_patch_set_other_config(session.opaque_ref, _host_patch, _other_config); else session.XmlRpcProxy.host_patch_set_other_config(session.opaque_ref, _host_patch ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } /// /// Add the given key-value pair to the other_config field of the given host_patch. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch /// Key to add /// Value to add public static void add_to_other_config(Session session, string _host_patch, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.host_patch_add_to_other_config(session.opaque_ref, _host_patch, _key, _value); else session.XmlRpcProxy.host_patch_add_to_other_config(session.opaque_ref, _host_patch ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the other_config field of the given host_patch. If the key is not in that Map, then do nothing. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch /// Key to remove public static void remove_from_other_config(Session session, string _host_patch, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.host_patch_remove_from_other_config(session.opaque_ref, _host_patch, _key); else session.XmlRpcProxy.host_patch_remove_from_other_config(session.opaque_ref, _host_patch ?? "", _key ?? "").parse(); } /// /// Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch /// First published in XenServer 4.0. /// Deprecated since XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch [Deprecated("XenServer 4.1")] public static void destroy(Session session, string _host_patch) { if (session.JsonRpcClient != null) session.JsonRpcClient.host_patch_destroy(session.opaque_ref, _host_patch); else session.XmlRpcProxy.host_patch_destroy(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch /// First published in XenServer 4.0. /// Deprecated since XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch [Deprecated("XenServer 4.1")] public static XenRef async_destroy(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_host_patch_destroy(session.opaque_ref, _host_patch); else return XenRef.Create(session.XmlRpcProxy.async_host_patch_destroy(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Apply the selected patch and return its output /// First published in XenServer 4.0. /// Deprecated since XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch [Deprecated("XenServer 4.1")] public static string apply(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_apply(session.opaque_ref, _host_patch); else return session.XmlRpcProxy.host_patch_apply(session.opaque_ref, _host_patch ?? "").parse(); } /// /// Apply the selected patch and return its output /// First published in XenServer 4.0. /// Deprecated since XenServer 4.1. /// /// The session /// The opaque_ref of the given host_patch [Deprecated("XenServer 4.1")] public static XenRef async_apply(Session session, string _host_patch) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_host_patch_apply(session.opaque_ref, _host_patch); else return XenRef.Create(session.XmlRpcProxy.async_host_patch_apply(session.opaque_ref, _host_patch ?? "").parse()); } /// /// Return a list of all the host_patchs known to the system. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.1. /// /// The session [Deprecated("XenServer 7.1")] public static List> get_all(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_all(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.host_patch_get_all(session.opaque_ref).parse()); } /// /// Get all the host_patch Records at once, in a single XML RPC call /// First published in XenServer 4.0. /// /// The session public static Dictionary, Host_patch> get_all_records(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.host_patch_get_all_records(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.host_patch_get_all_records(session.opaque_ref).parse()); } /// /// Unique identifier/object reference /// public virtual string uuid { get { return _uuid; } set { if (!Helper.AreEqual(value, _uuid)) { _uuid = value; NotifyPropertyChanged("uuid"); } } } private string _uuid = ""; /// /// a human-readable name /// public virtual string name_label { get { return _name_label; } set { if (!Helper.AreEqual(value, _name_label)) { _name_label = value; NotifyPropertyChanged("name_label"); } } } private string _name_label = ""; /// /// a notes field containing human-readable description /// public virtual string name_description { get { return _name_description; } set { if (!Helper.AreEqual(value, _name_description)) { _name_description = value; NotifyPropertyChanged("name_description"); } } } private string _name_description = ""; /// /// Patch version number /// public virtual string version { get { return _version; } set { if (!Helper.AreEqual(value, _version)) { _version = value; NotifyPropertyChanged("version"); } } } private string _version = ""; /// /// Host the patch relates to /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef host { get { return _host; } set { if (!Helper.AreEqual(value, _host)) { _host = value; NotifyPropertyChanged("host"); } } } private XenRef _host = new XenRef(Helper.NullOpaqueRef); /// /// True if the patch has been applied /// public virtual bool applied { get { return _applied; } set { if (!Helper.AreEqual(value, _applied)) { _applied = value; NotifyPropertyChanged("applied"); } } } private bool _applied; /// /// Time the patch was applied /// [JsonConverter(typeof(XenDateTimeConverter))] public virtual DateTime timestamp_applied { get { return _timestamp_applied; } set { if (!Helper.AreEqual(value, _timestamp_applied)) { _timestamp_applied = value; NotifyPropertyChanged("timestamp_applied"); } } } private DateTime _timestamp_applied; /// /// Size of the patch /// public virtual long size { get { return _size; } set { if (!Helper.AreEqual(value, _size)) { _size = value; NotifyPropertyChanged("size"); } } } private long _size; /// /// The patch applied /// First published in XenServer 4.1. /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef pool_patch { get { return _pool_patch; } set { if (!Helper.AreEqual(value, _pool_patch)) { _pool_patch = value; NotifyPropertyChanged("pool_patch"); } } } private XenRef _pool_patch = new XenRef(Helper.NullOpaqueRef); /// /// additional configuration /// First published in XenServer 4.1. /// [JsonConverter(typeof(StringStringMapConverter))] public virtual Dictionary other_config { get { return _other_config; } set { if (!Helper.AreEqual(value, _other_config)) { _other_config = value; NotifyPropertyChanged("other_config"); } } } private Dictionary _other_config = new Dictionary() {}; } }