/* * 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 { /// /// A VM crashdump /// First published in XenServer 4.0. /// public partial class Crashdump : XenObject { #region Constructors public Crashdump() { } public Crashdump(string uuid, XenRef VM, XenRef VDI, Dictionary other_config) { this.uuid = uuid; this.VM = VM; this.VDI = VDI; this.other_config = other_config; } /// /// Creates a new Crashdump from a Hashtable. /// Note that the fields not contained in the Hashtable /// will be created with their default values. /// /// public Crashdump(Hashtable table) : this() { UpdateFrom(table); } /// /// Creates a new Crashdump from a Proxy_Crashdump. /// /// public Crashdump(Proxy_Crashdump proxy) { UpdateFrom(proxy); } #endregion /// /// Updates each field of this instance with the value of /// the corresponding field of a given Crashdump. /// public override void UpdateFrom(Crashdump update) { uuid = update.uuid; VM = update.VM; VDI = update.VDI; other_config = update.other_config; } internal void UpdateFrom(Proxy_Crashdump proxy) { uuid = proxy.uuid == null ? null : proxy.uuid; VM = proxy.VM == null ? null : XenRef.Create(proxy.VM); VDI = proxy.VDI == null ? null : XenRef.Create(proxy.VDI); other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config); } public Proxy_Crashdump ToProxy() { Proxy_Crashdump result_ = new Proxy_Crashdump(); result_.uuid = uuid ?? ""; result_.VM = VM ?? ""; result_.VDI = VDI ?? ""; 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 Crashdump /// 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("VM")) VM = Marshalling.ParseRef(table, "VM"); if (table.ContainsKey("VDI")) VDI = Marshalling.ParseRef(table, "VDI"); if (table.ContainsKey("other_config")) other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config")); } public bool DeepEquals(Crashdump other) { if (ReferenceEquals(null, other)) return false; if (ReferenceEquals(this, other)) return true; return Helper.AreEqual2(this._uuid, other._uuid) && Helper.AreEqual2(this._VM, other._VM) && Helper.AreEqual2(this._VDI, other._VDI) && Helper.AreEqual2(this._other_config, other._other_config); } internal static List ProxyArrayToObjectList(Proxy_Crashdump[] input) { var result = new List(); foreach (var item in input) result.Add(new Crashdump(item)); return result; } public override string SaveChanges(Session session, string opaqueRef, Crashdump 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)) { Crashdump.set_other_config(session, opaqueRef, _other_config); } return null; } } /// /// Get a record containing the current state of the given crashdump. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.3. /// /// The session /// The opaque_ref of the given crashdump [Deprecated("XenServer 7.3")] public static Crashdump get_record(Session session, string _crashdump) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_record(session.opaque_ref, _crashdump); else return new Crashdump(session.proxy.crashdump_get_record(session.opaque_ref, _crashdump ?? "").parse()); } /// /// Get a reference to the crashdump instance with the specified UUID. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.3. /// /// The session /// UUID of object to return [Deprecated("XenServer 7.3")] public static XenRef get_by_uuid(Session session, string _uuid) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_by_uuid(session.opaque_ref, _uuid); else return XenRef.Create(session.proxy.crashdump_get_by_uuid(session.opaque_ref, _uuid ?? "").parse()); } /// /// Get the uuid field of the given crashdump. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given crashdump public static string get_uuid(Session session, string _crashdump) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_uuid(session.opaque_ref, _crashdump); else return session.proxy.crashdump_get_uuid(session.opaque_ref, _crashdump ?? "").parse(); } /// /// Get the VM field of the given crashdump. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given crashdump public static XenRef get_VM(Session session, string _crashdump) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_vm(session.opaque_ref, _crashdump); else return XenRef.Create(session.proxy.crashdump_get_vm(session.opaque_ref, _crashdump ?? "").parse()); } /// /// Get the VDI field of the given crashdump. /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given crashdump public static XenRef get_VDI(Session session, string _crashdump) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_vdi(session.opaque_ref, _crashdump); else return XenRef.Create(session.proxy.crashdump_get_vdi(session.opaque_ref, _crashdump ?? "").parse()); } /// /// Get the other_config field of the given crashdump. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given crashdump public static Dictionary get_other_config(Session session, string _crashdump) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_other_config(session.opaque_ref, _crashdump); else return Maps.convert_from_proxy_string_string(session.proxy.crashdump_get_other_config(session.opaque_ref, _crashdump ?? "").parse()); } /// /// Set the other_config field of the given crashdump. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given crashdump /// New value to set public static void set_other_config(Session session, string _crashdump, Dictionary _other_config) { if (session.JsonRpcClient != null) session.JsonRpcClient.crashdump_set_other_config(session.opaque_ref, _crashdump, _other_config); else session.proxy.crashdump_set_other_config(session.opaque_ref, _crashdump ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } /// /// Add the given key-value pair to the other_config field of the given crashdump. /// First published in XenServer 4.1. /// /// The session /// The opaque_ref of the given crashdump /// Key to add /// Value to add public static void add_to_other_config(Session session, string _crashdump, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.crashdump_add_to_other_config(session.opaque_ref, _crashdump, _key, _value); else session.proxy.crashdump_add_to_other_config(session.opaque_ref, _crashdump ?? "", _key ?? "", _value ?? "").parse(); } /// /// Remove the given key and its corresponding value from the other_config field of the given crashdump. 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 crashdump /// Key to remove public static void remove_from_other_config(Session session, string _crashdump, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.crashdump_remove_from_other_config(session.opaque_ref, _crashdump, _key); else session.proxy.crashdump_remove_from_other_config(session.opaque_ref, _crashdump ?? "", _key ?? "").parse(); } /// /// Destroy the specified crashdump /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given crashdump public static void destroy(Session session, string _crashdump) { if (session.JsonRpcClient != null) session.JsonRpcClient.crashdump_destroy(session.opaque_ref, _crashdump); else session.proxy.crashdump_destroy(session.opaque_ref, _crashdump ?? "").parse(); } /// /// Destroy the specified crashdump /// First published in XenServer 4.0. /// /// The session /// The opaque_ref of the given crashdump public static XenRef async_destroy(Session session, string _crashdump) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_crashdump_destroy(session.opaque_ref, _crashdump); else return XenRef.Create(session.proxy.async_crashdump_destroy(session.opaque_ref, _crashdump ?? "").parse()); } /// /// Return a list of all the crashdumps known to the system. /// First published in XenServer 4.0. /// Deprecated since XenServer 7.3. /// /// The session [Deprecated("XenServer 7.3")] public static List> get_all(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_all(session.opaque_ref); else return XenRef.Create(session.proxy.crashdump_get_all(session.opaque_ref).parse()); } /// /// Get all the crashdump Records at once, in a single XML RPC call /// First published in XenServer 4.0. /// /// The session public static Dictionary, Crashdump> get_all_records(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.crashdump_get_all_records(session.opaque_ref); else return XenRef.Create(session.proxy.crashdump_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; Changed = true; NotifyPropertyChanged("uuid"); } } } private string _uuid = ""; /// /// the virtual machine /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef VM { get { return _VM; } set { if (!Helper.AreEqual(value, _VM)) { _VM = value; Changed = true; NotifyPropertyChanged("VM"); } } } private XenRef _VM = new XenRef(Helper.NullOpaqueRef); /// /// the virtual disk /// [JsonConverter(typeof(XenRefConverter))] public virtual XenRef VDI { get { return _VDI; } set { if (!Helper.AreEqual(value, _VDI)) { _VDI = value; Changed = true; NotifyPropertyChanged("VDI"); } } } private XenRef _VDI = 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; Changed = true; NotifyPropertyChanged("other_config"); } } } private Dictionary _other_config = new Dictionary() {}; } }