/*
* 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 console
/// First published in XenServer 4.0.
///
public partial class Console : XenObject
{
public Console()
{
}
public Console(string uuid,
console_protocol protocol,
string location,
XenRef VM,
Dictionary other_config)
{
this.uuid = uuid;
this.protocol = protocol;
this.location = location;
this.VM = VM;
this.other_config = other_config;
}
///
/// Creates a new Console from a Proxy_Console.
///
///
public Console(Proxy_Console proxy)
{
this.UpdateFromProxy(proxy);
}
public override void UpdateFrom(Console update)
{
uuid = update.uuid;
protocol = update.protocol;
location = update.location;
VM = update.VM;
other_config = update.other_config;
}
internal void UpdateFromProxy(Proxy_Console proxy)
{
uuid = proxy.uuid == null ? null : (string)proxy.uuid;
protocol = proxy.protocol == null ? (console_protocol) 0 : (console_protocol)Helper.EnumParseDefault(typeof(console_protocol), (string)proxy.protocol);
location = proxy.location == null ? null : (string)proxy.location;
VM = proxy.VM == null ? null : XenRef.Create(proxy.VM);
other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config);
}
public Proxy_Console ToProxy()
{
Proxy_Console result_ = new Proxy_Console();
result_.uuid = uuid ?? "";
result_.protocol = console_protocol_helper.ToString(protocol);
result_.location = location ?? "";
result_.VM = VM ?? "";
result_.other_config = Maps.convert_to_proxy_string_string(other_config);
return result_;
}
///
/// Creates a new Console from a Hashtable.
///
///
public Console(Hashtable table)
{
uuid = Marshalling.ParseString(table, "uuid");
protocol = (console_protocol)Helper.EnumParseDefault(typeof(console_protocol), Marshalling.ParseString(table, "protocol"));
location = Marshalling.ParseString(table, "location");
VM = Marshalling.ParseRef(table, "VM");
other_config = Maps.convert_from_proxy_string_string(Marshalling.ParseHashTable(table, "other_config"));
}
public bool DeepEquals(Console other)
{
if (ReferenceEquals(null, other))
return false;
if (ReferenceEquals(this, other))
return true;
return Helper.AreEqual2(this._uuid, other._uuid) &&
Helper.AreEqual2(this._protocol, other._protocol) &&
Helper.AreEqual2(this._location, other._location) &&
Helper.AreEqual2(this._VM, other._VM) &&
Helper.AreEqual2(this._other_config, other._other_config);
}
internal static List ProxyArrayToObjectList(Proxy_Console[] input)
{
var result = new List();
foreach (var item in input)
result.Add(new Console(item));
return result;
}
public override string SaveChanges(Session session, string opaqueRef, Console server)
{
if (opaqueRef == null)
{
var reference = create(session, this);
return reference == null ? null : reference.opaque_ref;
}
else
{
if (!Helper.AreEqual2(_other_config, server._other_config))
{
Console.set_other_config(session, opaqueRef, _other_config);
}
return null;
}
}
///
/// Get a record containing the current state of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static Console get_record(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_record(session.uuid, _console);
else
return new Console((Proxy_Console)session.proxy.console_get_record(session.uuid, _console ?? "").parse());
}
///
/// Get a reference to the console instance with the specified UUID.
/// First published in XenServer 4.0.
///
/// The session
/// UUID of object to return
public static XenRef get_by_uuid(Session session, string _uuid)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_by_uuid(session.uuid, _uuid);
else
return XenRef.Create(session.proxy.console_get_by_uuid(session.uuid, _uuid ?? "").parse());
}
///
/// Create a new console instance, and return its handle.
/// First published in XenServer 4.0.
///
/// The session
/// All constructor arguments
public static XenRef create(Session session, Console _record)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_create(session.uuid, _record);
else
return XenRef.Create(session.proxy.console_create(session.uuid, _record.ToProxy()).parse());
}
///
/// Create a new console instance, and return its handle.
/// First published in XenServer 4.0.
///
/// The session
/// All constructor arguments
public static XenRef async_create(Session session, Console _record)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.async_console_create(session.uuid, _record);
else
return XenRef.Create(session.proxy.async_console_create(session.uuid, _record.ToProxy()).parse());
}
///
/// Destroy the specified console instance.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static void destroy(Session session, string _console)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.console_destroy(session.uuid, _console);
else
session.proxy.console_destroy(session.uuid, _console ?? "").parse();
}
///
/// Destroy the specified console instance.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static XenRef async_destroy(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.async_console_destroy(session.uuid, _console);
else
return XenRef.Create(session.proxy.async_console_destroy(session.uuid, _console ?? "").parse());
}
///
/// Get the uuid field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static string get_uuid(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_uuid(session.uuid, _console);
else
return (string)session.proxy.console_get_uuid(session.uuid, _console ?? "").parse();
}
///
/// Get the protocol field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static console_protocol get_protocol(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_protocol(session.uuid, _console);
else
return (console_protocol)Helper.EnumParseDefault(typeof(console_protocol), (string)session.proxy.console_get_protocol(session.uuid, _console ?? "").parse());
}
///
/// Get the location field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static string get_location(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_location(session.uuid, _console);
else
return (string)session.proxy.console_get_location(session.uuid, _console ?? "").parse();
}
///
/// Get the VM field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static XenRef get_VM(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_vm(session.uuid, _console);
else
return XenRef.Create(session.proxy.console_get_vm(session.uuid, _console ?? "").parse());
}
///
/// Get the other_config field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
public static Dictionary get_other_config(Session session, string _console)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_other_config(session.uuid, _console);
else
return Maps.convert_from_proxy_string_string(session.proxy.console_get_other_config(session.uuid, _console ?? "").parse());
}
///
/// Set the other_config field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
/// New value to set
public static void set_other_config(Session session, string _console, Dictionary _other_config)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.console_set_other_config(session.uuid, _console, _other_config);
else
session.proxy.console_set_other_config(session.uuid, _console ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse();
}
///
/// Add the given key-value pair to the other_config field of the given console.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
/// Key to add
/// Value to add
public static void add_to_other_config(Session session, string _console, string _key, string _value)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.console_add_to_other_config(session.uuid, _console, _key, _value);
else
session.proxy.console_add_to_other_config(session.uuid, _console ?? "", _key ?? "", _value ?? "").parse();
}
///
/// Remove the given key and its corresponding value from the other_config field of the given console. If the key is not in that Map, then do nothing.
/// First published in XenServer 4.0.
///
/// The session
/// The opaque_ref of the given console
/// Key to remove
public static void remove_from_other_config(Session session, string _console, string _key)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.console_remove_from_other_config(session.uuid, _console, _key);
else
session.proxy.console_remove_from_other_config(session.uuid, _console ?? "", _key ?? "").parse();
}
///
/// Return a list of all the consoles known to the system.
/// First published in XenServer 4.0.
///
/// The session
public static List> get_all(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_all(session.uuid);
else
return XenRef.Create(session.proxy.console_get_all(session.uuid).parse());
}
///
/// Get all the console Records at once, in a single XML RPC call
/// First published in XenServer 4.0.
///
/// The session
public static Dictionary, Console> get_all_records(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.console_get_all_records(session.uuid);
else
return XenRef.Create(session.proxy.console_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 protocol used by this console
///
[JsonConverter(typeof(console_protocolConverter))]
public virtual console_protocol protocol
{
get { return _protocol; }
set
{
if (!Helper.AreEqual(value, _protocol))
{
_protocol = value;
Changed = true;
NotifyPropertyChanged("protocol");
}
}
}
private console_protocol _protocol;
///
/// URI for the console service
///
public virtual string location
{
get { return _location; }
set
{
if (!Helper.AreEqual(value, _location))
{
_location = value;
Changed = true;
NotifyPropertyChanged("location");
}
}
}
private string _location = "";
///
/// VM to which this console is attached
///
[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);
///
/// 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() {};
}
}