| /* | |
| * 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. | |
| */ | |
| package com.xensource.xenapi; | |
| import com.xensource.xenapi.Types.BadServerResponse; | |
| import com.xensource.xenapi.Types.VersionException; | |
| import com.xensource.xenapi.Types.XenAPIException; | |
| import java.io.PrintWriter; | |
| import java.io.StringWriter; | |
| import java.util.Date; | |
| import java.util.HashMap; | |
| import java.util.LinkedHashSet; | |
| import java.util.Map; | |
| import java.util.Set; | |
| import org.apache.xmlrpc.XmlRpcException; | |
| /** | |
| * Represents a patch stored on a server | |
| * | |
| * @author Citrix Systems, Inc. | |
| */ | |
| public class HostPatch extends XenAPIObject { | |
| /** | |
| * The XenAPI reference (OpaqueRef) to this object. | |
| */ | |
| protected final String ref; | |
| /** | |
| * For internal use only. | |
| */ | |
| HostPatch(String ref) { | |
| this.ref = ref; | |
| } | |
| /** | |
| * @return The XenAPI reference (OpaqueRef) to this object. | |
| */ | |
| public String toWireString() { | |
| return this.ref; | |
| } | |
| /** | |
| * If obj is a HostPatch, compares XenAPI references for equality. | |
| */ | |
| @Override | |
| public boolean equals(Object obj) | |
| { | |
| if (obj != null && obj instanceof HostPatch) | |
| { | |
| HostPatch other = (HostPatch) obj; | |
| return other.ref.equals(this.ref); | |
| } else | |
| { | |
| return false; | |
| } | |
| } | |
| @Override | |
| public int hashCode() | |
| { | |
| return ref.hashCode(); | |
| } | |
| /** | |
| * Represents all the fields in a HostPatch | |
| */ | |
| public static class Record implements Types.Record { | |
| public String toString() { | |
| StringWriter writer = new StringWriter(); | |
| PrintWriter print = new PrintWriter(writer); | |
| print.printf("%1$20s: %2$s\n", "uuid", this.uuid); | |
| print.printf("%1$20s: %2$s\n", "nameLabel", this.nameLabel); | |
| print.printf("%1$20s: %2$s\n", "nameDescription", this.nameDescription); | |
| print.printf("%1$20s: %2$s\n", "version", this.version); | |
| print.printf("%1$20s: %2$s\n", "host", this.host); | |
| print.printf("%1$20s: %2$s\n", "applied", this.applied); | |
| print.printf("%1$20s: %2$s\n", "timestampApplied", this.timestampApplied); | |
| print.printf("%1$20s: %2$s\n", "size", this.size); | |
| print.printf("%1$20s: %2$s\n", "poolPatch", this.poolPatch); | |
| print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig); | |
| return writer.toString(); | |
| } | |
| /** | |
| * Convert a host_patch.Record to a Map | |
| */ | |
| public Map<String,Object> toMap() { | |
| Map<String,Object> map = new HashMap<String,Object>(); | |
| map.put("uuid", this.uuid == null ? "" : this.uuid); | |
| map.put("name_label", this.nameLabel == null ? "" : this.nameLabel); | |
| map.put("name_description", this.nameDescription == null ? "" : this.nameDescription); | |
| map.put("version", this.version == null ? "" : this.version); | |
| map.put("host", this.host == null ? new Host("OpaqueRef:NULL") : this.host); | |
| map.put("applied", this.applied == null ? false : this.applied); | |
| map.put("timestamp_applied", this.timestampApplied == null ? new Date(0) : this.timestampApplied); | |
| map.put("size", this.size == null ? 0 : this.size); | |
| map.put("pool_patch", this.poolPatch == null ? new PoolPatch("OpaqueRef:NULL") : this.poolPatch); | |
| map.put("other_config", this.otherConfig == null ? new HashMap<String, String>() : this.otherConfig); | |
| return map; | |
| } | |
| /** | |
| * Unique identifier/object reference | |
| */ | |
| public String uuid; | |
| /** | |
| * a human-readable name | |
| */ | |
| public String nameLabel; | |
| /** | |
| * a notes field containing human-readable description | |
| */ | |
| public String nameDescription; | |
| /** | |
| * Patch version number | |
| */ | |
| public String version; | |
| /** | |
| * Host the patch relates to | |
| */ | |
| public Host host; | |
| /** | |
| * True if the patch has been applied | |
| */ | |
| public Boolean applied; | |
| /** | |
| * Time the patch was applied | |
| */ | |
| public Date timestampApplied; | |
| /** | |
| * Size of the patch | |
| */ | |
| public Long size; | |
| /** | |
| * The patch applied | |
| */ | |
| public PoolPatch poolPatch; | |
| /** | |
| * additional configuration | |
| */ | |
| public Map<String, String> otherConfig; | |
| } | |
| /** | |
| * Get a record containing the current state of the given host_patch. | |
| * | |
| * @return all fields from the object | |
| */ | |
| public HostPatch.Record getRecord(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_record"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toHostPatchRecord(result); | |
| } | |
| /** | |
| * Get a reference to the host_patch instance with the specified UUID. | |
| * | |
| * @param uuid UUID of object to return | |
| * @return reference to the object | |
| */ | |
| public static HostPatch getByUuid(Connection c, String uuid) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_by_uuid"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(uuid)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toHostPatch(result); | |
| } | |
| /** | |
| * Get all the host_patch instances with the given label. | |
| * | |
| * @param label label of object to return | |
| * @return references to objects with matching names | |
| */ | |
| public static Set<HostPatch> getByNameLabel(Connection c, String label) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_by_name_label"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(label)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toSetOfHostPatch(result); | |
| } | |
| /** | |
| * Get the uuid field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public String getUuid(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_uuid"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toString(result); | |
| } | |
| /** | |
| * Get the name/label field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public String getNameLabel(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_name_label"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toString(result); | |
| } | |
| /** | |
| * Get the name/description field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public String getNameDescription(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_name_description"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toString(result); | |
| } | |
| /** | |
| * Get the version field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public String getVersion(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_version"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toString(result); | |
| } | |
| /** | |
| * Get the host field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public Host getHost(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_host"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toHost(result); | |
| } | |
| /** | |
| * Get the applied field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public Boolean getApplied(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_applied"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toBoolean(result); | |
| } | |
| /** | |
| * Get the timestamp_applied field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public Date getTimestampApplied(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_timestamp_applied"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toDate(result); | |
| } | |
| /** | |
| * Get the size field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public Long getSize(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_size"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toLong(result); | |
| } | |
| /** | |
| * Get the pool_patch field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public PoolPatch getPoolPatch(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_pool_patch"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toPoolPatch(result); | |
| } | |
| /** | |
| * Get the other_config field of the given host_patch. | |
| * | |
| * @return value of the field | |
| */ | |
| public Map<String, String> getOtherConfig(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_other_config"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toMapOfStringString(result); | |
| } | |
| /** | |
| * Set the other_config field of the given host_patch. | |
| * | |
| * @param otherConfig New value to set | |
| */ | |
| public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.set_other_config"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(otherConfig)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| return; | |
| } | |
| /** | |
| * Add the given key-value pair to the other_config field of the given host_patch. | |
| * | |
| * @param key Key to add | |
| * @param value Value to add | |
| */ | |
| public void addToOtherConfig(Connection c, String key, String value) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.add_to_other_config"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key), Marshalling.toXMLRPC(value)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| return; | |
| } | |
| /** | |
| * 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. | |
| * | |
| * @param key Key to remove | |
| */ | |
| public void removeFromOtherConfig(Connection c, String key) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.remove_from_other_config"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| return; | |
| } | |
| /** | |
| * Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch | |
| * @deprecated | |
| * | |
| * @return Task | |
| */ | |
| @Deprecated public Task destroyAsync(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "Async.host_patch.destroy"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toTask(result); | |
| } | |
| /** | |
| * Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch | |
| * @deprecated | |
| * | |
| */ | |
| @Deprecated public void destroy(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.destroy"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| return; | |
| } | |
| /** | |
| * Apply the selected patch and return its output | |
| * @deprecated | |
| * | |
| * @return Task | |
| */ | |
| @Deprecated public Task applyAsync(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "Async.host_patch.apply"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toTask(result); | |
| } | |
| /** | |
| * Apply the selected patch and return its output | |
| * @deprecated | |
| * | |
| * @return the output of the patch application process | |
| */ | |
| @Deprecated public String apply(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.apply"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toString(result); | |
| } | |
| /** | |
| * Return a list of all the host_patchs known to the system. | |
| * | |
| * @return references to all objects | |
| */ | |
| public static Set<HostPatch> getAll(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_all"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toSetOfHostPatch(result); | |
| } | |
| /** | |
| * Return a map of host_patch references to host_patch records for all host_patchs known to the system. | |
| * | |
| * @return records of all objects | |
| */ | |
| public static Map<HostPatch, HostPatch.Record> getAllRecords(Connection c) throws | |
| BadServerResponse, | |
| XenAPIException, | |
| XmlRpcException { | |
| String method_call = "host_patch.get_all_records"; | |
| String session = c.getSessionReference(); | |
| Object[] method_params = {Marshalling.toXMLRPC(session)}; | |
| Map response = c.dispatch(method_call, method_params); | |
| Object result = response.get("Value"); | |
| return Types.toMapOfHostPatchHostPatchRecord(result); | |
| } | |
| } |