/*
*============================================================================
* This library is free software; you can redistribute it and/or
* modify it under the terms of version 2.1 of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*============================================================================
* Copyright (C) 2007 XenSource Inc.
*============================================================================
*/
package com.xensource.xenapi;
import java.util.Map;
import java.util.Set;
import java.util.Date;
import java.lang.ref.SoftReference;
import java.util.HashMap;
import java.util.HashSet;
import java.io.PrintWriter;
import java.io.StringWriter;
import org.apache.xmlrpc.XmlRpcException;
/**
* A VLAN mux/demux
*
* @author XenSource Inc.
*/
public class VLAN extends XenAPIObject {
/**
* The XenAPI reference to this object.
*/
protected final String ref;
private VLAN(String ref) {
this.ref = ref;
}
public String toWireString() {
return this.ref;
}
/**
* This code helps ensure there is only one
* VLAN instance per XenAPI reference.
*/
private static final Map<String,SoftReference<VLAN>> cache =
new HashMap<String,SoftReference<VLAN>>();
protected static synchronized VLAN getInstFromRef(String ref) {
if(VLAN.cache.containsKey(ref)) {
VLAN instance =
VLAN.cache.get(ref).get();
if(instance != null) {
return instance;
}
}
VLAN instance = new VLAN(ref);
VLAN.cache.put(ref, new SoftReference<VLAN>(instance));
return instance;
}
/**
* Represents all the fields in a VLAN
*/
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", "taggedPIF", this.taggedPIF);
print.printf("%1$20s: %2$s\n", "untaggedPIF", this.untaggedPIF);
print.printf("%1$20s: %2$s\n", "tag", this.tag);
print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig);
return writer.toString();
}
/**
* Convert a VLAN.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("tagged_PIF", this.taggedPIF == null ? com.xensource.xenapi.PIF.getInstFromRef("OpaqueRef:NULL") : this.taggedPIF);
map.put("untagged_PIF", this.untaggedPIF == null ? com.xensource.xenapi.PIF.getInstFromRef("OpaqueRef:NULL") : this.untaggedPIF);
map.put("tag", this.tag == null ? 0 : this.tag);
map.put("other_config", this.otherConfig == null ? new HashMap<String, String>() : this.otherConfig);
return map;
}
/**
* unique identifier/object reference
*/
public String uuid;
/**
* interface on which traffic is tagged
*/
public PIF taggedPIF;
/**
* interface on which traffic is untagged
*/
public PIF untaggedPIF;
/**
* VLAN tag in use
*/
public Long tag;
/**
* additional configuration
*/
public Map<String, String> otherConfig;
}
/**
* Get a record containing the current state of the given VLAN.
*
* @return all fields from the object
*/
public VLAN.Record getRecord(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_record";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toVLANRecord(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Get a reference to the VLAN instance with the specified UUID.
*
* @param uuid UUID of object to return
* @return reference to the object
*/
public static VLAN getByUuid(Connection c, String uuid) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_by_uuid";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(uuid)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toVLAN(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Get the uuid field of the given VLAN.
*
* @return value of the field
*/
public String getUuid(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_uuid";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toString(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Get the tagged_PIF field of the given VLAN.
*
* @return value of the field
*/
public PIF getTaggedPIF(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_tagged_PIF";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toPIF(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Get the untagged_PIF field of the given VLAN.
*
* @return value of the field
*/
public PIF getUntaggedPIF(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_untagged_PIF";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toPIF(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Get the tag field of the given VLAN.
*
* @return value of the field
*/
public Long getTag(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_tag";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toLong(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Get the other_config field of the given VLAN.
*
* @return value of the field
*/
public Map<String, String> getOtherConfig(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.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);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toMapOfStringString(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Set the other_config field of the given VLAN.
*
* @param otherConfig New value to set
*/
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.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);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return;
}
throw new Types.BadServerResponse(response);
}
/**
* Add the given key-value pair to the other_config field of the given VLAN.
*
* @param key Key to add
* @param value Value to add
*/
public void addToOtherConfig(Connection c, String key, String value) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.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);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return;
}
throw new Types.BadServerResponse(response);
}
/**
* Remove the given key and its corresponding value from the other_config field of the given VLAN. If the key is not in that Map, then do nothing.
*
* @param key Key to remove
*/
public void removeFromOtherConfig(Connection c, String key) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.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);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return;
}
throw new Types.BadServerResponse(response);
}
/**
* Create a VLAN mux/demuxer
*
* @param taggedPIF PIF which receives the tagged traffic
* @param tag VLAN tag in use
* @param network Network to receive the untagged traffic
* @return Task
*/
public static Task createAsync(Connection c, PIF taggedPIF, Long tag, Network network) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "Async.VLAN.create";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(taggedPIF), Marshalling.toXMLRPC(tag), Marshalling.toXMLRPC(network)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toTask(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Create a VLAN mux/demuxer
*
* @param taggedPIF PIF which receives the tagged traffic
* @param tag VLAN tag in use
* @param network Network to receive the untagged traffic
* @return The reference of the created VLAN object
*/
public static VLAN create(Connection c, PIF taggedPIF, Long tag, Network network) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.create";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(taggedPIF), Marshalling.toXMLRPC(tag), Marshalling.toXMLRPC(network)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toVLAN(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Destroy a VLAN mux/demuxer
*
* @return Task
*/
public Task destroyAsync(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "Async.VLAN.destroy";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toTask(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Destroy a VLAN mux/demuxer
*
*/
public void destroy(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.destroy";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return;
}
throw new Types.BadServerResponse(response);
}
/**
* Return a list of all the VLANs known to the system.
*
* @return references to all objects
*/
public static Set<VLAN> getAll(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_all";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toSetOfVLAN(result);
}
throw new Types.BadServerResponse(response);
}
/**
* Return a map of VLAN references to VLAN records for all VLANs known to the system.
*
* @return records of all objects
*/
public static Map<VLAN, VLAN.Record> getAllRecords(Connection c) throws
Types.BadServerResponse,
XmlRpcException {
String method_call = "VLAN.get_all_records";
String session = c.getSessionReference();
Object[] method_params = {Marshalling.toXMLRPC(session)};
Map response = c.dispatch(method_call, method_params);
if(response.get("Status").equals("Success")) {
Object result = response.get("Value");
return Types.toMapOfVLANVLANRecord(result);
}
throw new Types.BadServerResponse(response);
}
}