// Copyright 2012 Citrix Systems, Inc. Licensed under the // Apache License, Version 2.0 (the "License"); you may not use this // file except in compliance with the License. Citrix Systems, Inc. // reserves all rights not expressly granted by the License. // You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // // Automatically generated by addcopyright.py at 04/03/2012 * follows: * Linking this library statically or dynamically with other modules is * making a combined work based on this library. Thus, the terms and * permission to link this library with independent modules to produce an * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 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; /** * A virtual network interface * * @author Citrix Systems, Inc. */ public class VIF extends XenAPIObject { /** * The XenAPI reference to this object. */ protected final String ref; /** * For internal use only. */ VIF(String ref) { this.ref = ref; } public String toWireString() { return this.ref; } /** * If obj is a VIF, compares XenAPI references for equality. */ @Override public boolean equals(Object obj) { if (obj != null && obj instanceof VIF) { VIF other = (VIF) obj; return other.ref.equals(this.ref); } else { return false; } } @Override public int hashCode() { return ref.hashCode(); } /** * Represents all the fields in a VIF */ 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", "allowedOperations", this.allowedOperations); print.printf("%1$20s: %2$s\n", "currentOperations", this.currentOperations); print.printf("%1$20s: %2$s\n", "device", this.device); print.printf("%1$20s: %2$s\n", "network", this.network); print.printf("%1$20s: %2$s\n", "VM", this.VM); print.printf("%1$20s: %2$s\n", "MAC", this.MAC); print.printf("%1$20s: %2$s\n", "MTU", this.MTU); print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig); print.printf("%1$20s: %2$s\n", "currentlyAttached", this.currentlyAttached); print.printf("%1$20s: %2$s\n", "statusCode", this.statusCode); print.printf("%1$20s: %2$s\n", "statusDetail", this.statusDetail); print.printf("%1$20s: %2$s\n", "runtimeProperties", this.runtimeProperties); print.printf("%1$20s: %2$s\n", "qosAlgorithmType", this.qosAlgorithmType); print.printf("%1$20s: %2$s\n", "qosAlgorithmParams", this.qosAlgorithmParams); print.printf("%1$20s: %2$s\n", "qosSupportedAlgorithms", this.qosSupportedAlgorithms); print.printf("%1$20s: %2$s\n", "metrics", this.metrics); print.printf("%1$20s: %2$s\n", "MACAutogenerated", this.MACAutogenerated); return writer.toString(); } /** * Convert a VIF.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("allowed_operations", this.allowedOperations == null ? new LinkedHashSet<Types.VifOperations>() : this.allowedOperations); map.put("current_operations", this.currentOperations == null ? new HashMap<String, Types.VifOperations>() : this.currentOperations); map.put("device", this.device == null ? "" : this.device); map.put("network", this.network == null ? new Network("OpaqueRef:NULL") : this.network); map.put("VM", this.VM == null ? new VM("OpaqueRef:NULL") : this.VM); map.put("MAC", this.MAC == null ? "" : this.MAC); map.put("MTU", this.MTU == null ? 0 : this.MTU); map.put("other_config", this.otherConfig == null ? new HashMap<String, String>() : this.otherConfig); map.put("currently_attached", this.currentlyAttached == null ? false : this.currentlyAttached); map.put("status_code", this.statusCode == null ? 0 : this.statusCode); map.put("status_detail", this.statusDetail == null ? "" : this.statusDetail); map.put("runtime_properties", this.runtimeProperties == null ? new HashMap<String, String>() : this.runtimeProperties); map.put("qos_algorithm_type", this.qosAlgorithmType == null ? "" : this.qosAlgorithmType); map.put("qos_algorithm_params", this.qosAlgorithmParams == null ? new HashMap<String, String>() : this.qosAlgorithmParams); map.put("qos_supported_algorithms", this.qosSupportedAlgorithms == null ? new LinkedHashSet<String>() : this.qosSupportedAlgorithms); map.put("metrics", this.metrics == null ? new VIFMetrics("OpaqueRef:NULL") : this.metrics); map.put("MAC_autogenerated", this.MACAutogenerated == null ? false : this.MACAutogenerated); return map; } /** * Unique identifier/object reference */ public String uuid; /** * list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. */ public Set<Types.VifOperations> allowedOperations; /** * links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task. */ public Map<String, Types.VifOperations> currentOperations; /** * order in which VIF backends are created by xapi */ public String device; /** * virtual network to which this vif is connected */ public Network network; /** * virtual machine to which this vif is connected */ public VM VM; /** * ethernet MAC address of virtual interface, as exposed to guest */ public String MAC; /** * MTU in octets */ public Long MTU; /** * additional configuration */ public Map<String, String> otherConfig; /** * is the device currently attached (erased on reboot) */ public Boolean currentlyAttached; /** * error/success code associated with last attach-operation (erased on reboot) */ public Long statusCode; /** * error/success information associated with last attach-operation status (erased on reboot) */ public String statusDetail; /** * Device runtime properties */ public Map<String, String> runtimeProperties; /** * QoS algorithm to use */ public String qosAlgorithmType; /** * parameters for chosen QoS algorithm */ public Map<String, String> qosAlgorithmParams; /** * supported QoS algorithms for this VIF */ public Set<String> qosSupportedAlgorithms; /** * metrics associated with this VIF */ public VIFMetrics metrics; /** * true if the MAC was autogenerated; false indicates it was set manually */ public Boolean MACAutogenerated; } /** * Get a record containing the current state of the given VIF. * * @return all fields from the object */ public VIF.Record getRecord(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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.toVIFRecord(result); } /** * Get a reference to the VIF instance with the specified UUID. * * @param uuid UUID of object to return * @return reference to the object */ public static VIF getByUuid(Connection c, String uuid) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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.toVIF(result); } /** * Create a new VIF instance, and return its handle. * * @param record All constructor arguments * @return Task */ public static Task createAsync(Connection c, VIF.Record record) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "Async.VIF.create"; String session = c.getSessionReference(); Map<String, Object> record_map = record.toMap(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(record_map)}; Map response = c.dispatch(method_call, method_params); Object result = response.get("Value"); return Types.toTask(result); } /** * Create a new VIF instance, and return its handle. * * @param record All constructor arguments * @return reference to the newly created object */ public static VIF create(Connection c, VIF.Record record) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.create"; String session = c.getSessionReference(); Map<String, Object> record_map = record.toMap(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(record_map)}; Map response = c.dispatch(method_call, method_params); Object result = response.get("Value"); return Types.toVIF(result); } /** * Destroy the specified VIF instance. * * @return Task */ public Task destroyAsync(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "Async.VIF.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 VIF instance. * */ public void destroy(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.destroy"; String session = c.getSessionReference(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; Map response = c.dispatch(method_call, method_params); return; } /** * Get the uuid field of the given VIF. * * @return value of the field */ public String getUuid(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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 allowed_operations field of the given VIF. * * @return value of the field */ public Set<Types.VifOperations> getAllowedOperations(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_allowed_operations"; 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.toSetOfVifOperations(result); } /** * Get the current_operations field of the given VIF. * * @return value of the field */ public Map<String, Types.VifOperations> getCurrentOperations(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_current_operations"; 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.toMapOfStringVifOperations(result); } /** * Get the device field of the given VIF. * * @return value of the field */ public String getDevice(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_device"; 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 network field of the given VIF. * * @return value of the field */ public Network getNetwork(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_network"; 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.toNetwork(result); } /** * Get the VM field of the given VIF. * * @return value of the field */ public VM getVM(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_VM"; 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.toVM(result); } /** * Get the MAC field of the given VIF. * * @return value of the field */ public String getMAC(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_MAC"; 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 MTU field of the given VIF. * * @return value of the field */ public Long getMTU(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_MTU"; 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 other_config field of the given VIF. * * @return value of the field */ public Map<String, String> getOtherConfig(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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); } /** * Get the currently_attached field of the given VIF. * * @return value of the field */ public Boolean getCurrentlyAttached(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_currently_attached"; 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 status_code field of the given VIF. * * @return value of the field */ public Long getStatusCode(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_status_code"; 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 status_detail field of the given VIF. * * @return value of the field */ public String getStatusDetail(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_status_detail"; 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 runtime_properties field of the given VIF. * * @return value of the field */ public Map<String, String> getRuntimeProperties(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_runtime_properties"; 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); } /** * Get the qos/algorithm_type field of the given VIF. * * @return value of the field */ public String getQosAlgorithmType(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_qos_algorithm_type"; 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 qos/algorithm_params field of the given VIF. * * @return value of the field */ public Map<String, String> getQosAlgorithmParams(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_qos_algorithm_params"; 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); } /** * Get the qos/supported_algorithms field of the given VIF. * * @return value of the field */ public Set<String> getQosSupportedAlgorithms(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_qos_supported_algorithms"; 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.toSetOfString(result); } /** * Get the metrics field of the given VIF. * * @return value of the field */ public VIFMetrics getMetrics(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_metrics"; 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.toVIFMetrics(result); } /** * Get the MAC_autogenerated field of the given VIF. * * @return value of the field */ public Boolean getMACAutogenerated(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.get_MAC_autogenerated"; 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); } /** * Set the other_config field of the given VIF. * * @param otherConfig New value to set */ public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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 VIF. * * @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 = "VIF.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 VIF. 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 = "VIF.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; } /** * Set the qos/algorithm_type field of the given VIF. * * @param algorithmType New value to set */ public void setQosAlgorithmType(Connection c, String algorithmType) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.set_qos_algorithm_type"; String session = c.getSessionReference(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(algorithmType)}; Map response = c.dispatch(method_call, method_params); return; } /** * Set the qos/algorithm_params field of the given VIF. * * @param algorithmParams New value to set */ public void setQosAlgorithmParams(Connection c, Map<String, String> algorithmParams) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.set_qos_algorithm_params"; String session = c.getSessionReference(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(algorithmParams)}; Map response = c.dispatch(method_call, method_params); return; } /** * Add the given key-value pair to the qos/algorithm_params field of the given VIF. * * @param key Key to add * @param value Value to add */ public void addToQosAlgorithmParams(Connection c, String key, String value) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.add_to_qos_algorithm_params"; 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 qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing. * * @param key Key to remove */ public void removeFromQosAlgorithmParams(Connection c, String key) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.remove_from_qos_algorithm_params"; 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; } /** * Hotplug the specified VIF, dynamically attaching it to the running VM * * @return Task */ public Task plugAsync(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "Async.VIF.plug"; 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); } /** * Hotplug the specified VIF, dynamically attaching it to the running VM * */ public void plug(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.plug"; String session = c.getSessionReference(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; Map response = c.dispatch(method_call, method_params); return; } /** * Hot-unplug the specified VIF, dynamically unattaching it from the running VM * * @return Task */ public Task unplugAsync(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "Async.VIF.unplug"; 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); } /** * Hot-unplug the specified VIF, dynamically unattaching it from the running VM * */ public void unplug(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.unplug"; String session = c.getSessionReference(); Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; Map response = c.dispatch(method_call, method_params); return; } /** * Return a list of all the VIFs known to the system. * * @return references to all objects */ public static Set<VIF> getAll(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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.toSetOfVIF(result); } /** * Return a map of VIF references to VIF records for all VIFs known to the system. * * @return records of all objects */ public static Map<VIF, VIF.Record> getAllRecords(Connection c) throws BadServerResponse, XenAPIException, XmlRpcException { String method_call = "VIF.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.toMapOfVIFVIFRecord(result); } }