|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Tunnel
public class Tunnel
A tunnel for network traffic
Nested Class Summary | |
---|---|
static class |
Tunnel.Record
Represents all the fields in a Tunnel |
Field Summary | |
---|---|
protected java.lang.String |
ref
The XenAPI reference to this object. |
Method Summary | |
---|---|
void |
addToOtherConfig(Connection c,
java.lang.String key,
java.lang.String value)
Add the given key-value pair to the other_config field of the given tunnel. |
void |
addToStatus(Connection c,
java.lang.String key,
java.lang.String value)
Add the given key-value pair to the status field of the given tunnel. |
static Tunnel |
create(Connection c,
PIF transportPIF,
Network network)
Create a tunnel |
static Task |
createAsync(Connection c,
PIF transportPIF,
Network network)
Create a tunnel |
void |
destroy(Connection c)
Destroy a tunnel |
Task |
destroyAsync(Connection c)
Destroy a tunnel |
boolean |
equals(java.lang.Object obj)
If obj is a Tunnel, compares XenAPI references for equality. |
PIF |
getAccessPIF(Connection c)
Get the access_PIF field of the given tunnel. |
static java.util.Set<Tunnel> |
getAll(Connection c)
Return a list of all the tunnels known to the system. |
static java.util.Map<Tunnel,Tunnel.Record> |
getAllRecords(Connection c)
Return a map of tunnel references to tunnel records for all tunnels known to the system. |
static Tunnel |
getByUuid(Connection c,
java.lang.String uuid)
Get a reference to the tunnel instance with the specified UUID. |
java.util.Map<java.lang.String,java.lang.String> |
getOtherConfig(Connection c)
Get the other_config field of the given tunnel. |
Tunnel.Record |
getRecord(Connection c)
Get a record containing the current state of the given tunnel. |
java.util.Map<java.lang.String,java.lang.String> |
getStatus(Connection c)
Get the status field of the given tunnel. |
PIF |
getTransportPIF(Connection c)
Get the transport_PIF field of the given tunnel. |
java.lang.String |
getUuid(Connection c)
Get the uuid field of the given tunnel. |
int |
hashCode()
|
void |
removeFromOtherConfig(Connection c,
java.lang.String key)
Remove the given key and its corresponding value from the other_config field of the given tunnel. |
void |
removeFromStatus(Connection c,
java.lang.String key)
Remove the given key and its corresponding value from the status field of the given tunnel. |
void |
setOtherConfig(Connection c,
java.util.Map<java.lang.String,java.lang.String> otherConfig)
Set the other_config field of the given tunnel. |
void |
setStatus(Connection c,
java.util.Map<java.lang.String,java.lang.String> status)
Set the status field of the given tunnel. |
java.lang.String |
toWireString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final java.lang.String ref
Method Detail |
---|
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Tunnel.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Tunnel getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to return
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public PIF getAccessPIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public PIF getTransportPIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setStatus(Connection c, java.util.Map<java.lang.String,java.lang.String> status) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
status
- New value to set
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToStatus(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to add
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromStatus(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to remove
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
otherConfig
- New value to set
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to add
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromOtherConfig(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to remove
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, PIF transportPIF, Network network) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif
transportPIF
- PIF which receives the tagged trafficnetwork
- Network to receive the tunnelled traffic
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OpenvswitchNotActive
Types.TransportPifNotConfigured
Types.IsTunnelAccessPif
public static Tunnel create(Connection c, PIF transportPIF, Network network) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif
transportPIF
- PIF which receives the tagged trafficnetwork
- Network to receive the tunnelled traffic
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OpenvswitchNotActive
Types.TransportPifNotConfigured
Types.IsTunnelAccessPif
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<Tunnel> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Map<Tunnel,Tunnel.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |