/*
* 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 secret
/// First published in XenServer 5.6.
///
public partial class Secret : XenObject
{
public Secret()
{
}
public Secret(string uuid,
string value,
Dictionary other_config)
{
this.uuid = uuid;
this.value = value;
this.other_config = other_config;
}
///
/// Creates a new Secret from a Proxy_Secret.
///
///
public Secret(Proxy_Secret proxy)
{
this.UpdateFromProxy(proxy);
}
///
/// Updates each field of this instance with the value of
/// the corresponding field of a given Secret.
///
public override void UpdateFrom(Secret update)
{
uuid = update.uuid;
value = update.value;
other_config = update.other_config;
}
internal void UpdateFromProxy(Proxy_Secret proxy)
{
uuid = proxy.uuid == null ? null : (string)proxy.uuid;
value = proxy.value == null ? null : (string)proxy.value;
other_config = proxy.other_config == null ? null : Maps.convert_from_proxy_string_string(proxy.other_config);
}
public Proxy_Secret ToProxy()
{
Proxy_Secret result_ = new Proxy_Secret();
result_.uuid = uuid ?? "";
result_.value = value ?? "";
result_.other_config = Maps.convert_to_proxy_string_string(other_config);
return result_;
}
///
/// Creates a new Secret from a Hashtable.
/// Note that the fields not contained in the Hashtable
/// will be created with their default values.
///
///
public Secret(Hashtable table) : this()
{
UpdateFrom(table);
}
///
/// Given a Hashtable with field-value pairs, it updates the fields of this Secret
/// 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("value"))
value = (string)table["value"];
if (table.ContainsKey("other_config"))
other_config = Maps.convert_from_proxy_string_string((Hashtable)table["other_config"]);
}
public bool DeepEquals(Secret other)
{
if (ReferenceEquals(null, other))
return false;
if (ReferenceEquals(this, other))
return true;
return Helper.AreEqual2(this._uuid, other._uuid) &&
Helper.AreEqual2(this._value, other._value) &&
Helper.AreEqual2(this._other_config, other._other_config);
}
internal static List ProxyArrayToObjectList(Proxy_Secret[] input)
{
var result = new List();
foreach (var item in input)
result.Add(new Secret(item));
return result;
}
public override string SaveChanges(Session session, string opaqueRef, Secret server)
{
if (opaqueRef == null)
{
var reference = create(session, this);
return reference == null ? null : reference.opaque_ref;
}
else
{
if (!Helper.AreEqual2(_value, server._value))
{
Secret.set_value(session, opaqueRef, _value);
}
if (!Helper.AreEqual2(_other_config, server._other_config))
{
Secret.set_other_config(session, opaqueRef, _other_config);
}
return null;
}
}
///
/// Get a record containing the current state of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
public static Secret get_record(Session session, string _secret)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_record(session.uuid, _secret);
else
return new Secret((Proxy_Secret)session.proxy.secret_get_record(session.uuid, _secret ?? "").parse());
}
///
/// Get a reference to the secret instance with the specified UUID.
/// First published in XenServer 5.6.
///
/// The session
/// UUID of object to return
public static XenRef get_by_uuid(Session session, string _uuid)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_by_uuid(session.uuid, _uuid);
else
return XenRef.Create(session.proxy.secret_get_by_uuid(session.uuid, _uuid ?? "").parse());
}
///
/// Create a new secret instance, and return its handle.
/// First published in XenServer 5.6.
///
/// The session
/// All constructor arguments
public static XenRef create(Session session, Secret _record)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_create(session.uuid, _record);
else
return XenRef.Create(session.proxy.secret_create(session.uuid, _record.ToProxy()).parse());
}
///
/// Create a new secret instance, and return its handle.
/// First published in XenServer 5.6.
///
/// The session
/// All constructor arguments
public static XenRef async_create(Session session, Secret _record)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.async_secret_create(session.uuid, _record);
else
return XenRef.Create(session.proxy.async_secret_create(session.uuid, _record.ToProxy()).parse());
}
///
/// Destroy the specified secret instance.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
public static void destroy(Session session, string _secret)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.secret_destroy(session.uuid, _secret);
else
session.proxy.secret_destroy(session.uuid, _secret ?? "").parse();
}
///
/// Destroy the specified secret instance.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
public static XenRef async_destroy(Session session, string _secret)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.async_secret_destroy(session.uuid, _secret);
else
return XenRef.Create(session.proxy.async_secret_destroy(session.uuid, _secret ?? "").parse());
}
///
/// Get the uuid field of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
public static string get_uuid(Session session, string _secret)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_uuid(session.uuid, _secret);
else
return (string)session.proxy.secret_get_uuid(session.uuid, _secret ?? "").parse();
}
///
/// Get the value field of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
public static string get_value(Session session, string _secret)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_value(session.uuid, _secret);
else
return (string)session.proxy.secret_get_value(session.uuid, _secret ?? "").parse();
}
///
/// Get the other_config field of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
public static Dictionary get_other_config(Session session, string _secret)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_other_config(session.uuid, _secret);
else
return Maps.convert_from_proxy_string_string(session.proxy.secret_get_other_config(session.uuid, _secret ?? "").parse());
}
///
/// Set the value field of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
/// New value to set
public static void set_value(Session session, string _secret, string _value)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.secret_set_value(session.uuid, _secret, _value);
else
session.proxy.secret_set_value(session.uuid, _secret ?? "", _value ?? "").parse();
}
///
/// Set the other_config field of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
/// New value to set
public static void set_other_config(Session session, string _secret, Dictionary _other_config)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.secret_set_other_config(session.uuid, _secret, _other_config);
else
session.proxy.secret_set_other_config(session.uuid, _secret ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse();
}
///
/// Add the given key-value pair to the other_config field of the given secret.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
/// Key to add
/// Value to add
public static void add_to_other_config(Session session, string _secret, string _key, string _value)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.secret_add_to_other_config(session.uuid, _secret, _key, _value);
else
session.proxy.secret_add_to_other_config(session.uuid, _secret ?? "", _key ?? "", _value ?? "").parse();
}
///
/// Remove the given key and its corresponding value from the other_config field of the given secret. If the key is not in that Map, then do nothing.
/// First published in XenServer 5.6.
///
/// The session
/// The opaque_ref of the given secret
/// Key to remove
public static void remove_from_other_config(Session session, string _secret, string _key)
{
if (session.JsonRpcClient != null)
session.JsonRpcClient.secret_remove_from_other_config(session.uuid, _secret, _key);
else
session.proxy.secret_remove_from_other_config(session.uuid, _secret ?? "", _key ?? "").parse();
}
///
/// Return a list of all the secrets known to the system.
/// First published in XenServer 5.6.
///
/// The session
public static List> get_all(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_all(session.uuid);
else
return XenRef.Create(session.proxy.secret_get_all(session.uuid).parse());
}
///
/// Get all the secret Records at once, in a single XML RPC call
/// First published in XenServer 5.6.
///
/// The session
public static Dictionary, Secret> get_all_records(Session session)
{
if (session.JsonRpcClient != null)
return session.JsonRpcClient.secret_get_all_records(session.uuid);
else
return XenRef.Create(session.proxy.secret_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 secret
///
public virtual string value
{
get { return _value; }
set
{
if (!Helper.AreEqual(value, _value))
{
_value = value;
Changed = true;
NotifyPropertyChanged("value");
}
}
}
private string _value = "";
///
/// other_config
///
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() {};
}
}