public class SDNController extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
SDNController.Record
Represents all the fields in a SDNController
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference (OpaqueRef) to this object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
If obj is a SDNController, compares XenAPI references for equality.
|
void |
forget(Connection c)
Remove the OVS manager of the pool and destroy the db record.
|
Task |
forgetAsync(Connection c)
Remove the OVS manager of the pool and destroy the db record.
|
java.lang.String |
getAddress(Connection c)
Get the address field of the given SDN_controller.
|
static java.util.Set<SDNController> |
getAll(Connection c)
Return a list of all the SDN_controllers known to the system.
|
static java.util.Map<SDNController,SDNController.Record> |
getAllRecords(Connection c)
Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system.
|
static SDNController |
getByUuid(Connection c,
java.lang.String uuid)
Get a reference to the SDN_controller instance with the specified UUID.
|
java.lang.Long |
getPort(Connection c)
Get the port field of the given SDN_controller.
|
Types.SdnControllerProtocol |
getProtocol(Connection c)
Get the protocol field of the given SDN_controller.
|
SDNController.Record |
getRecord(Connection c)
Get a record containing the current state of the given SDN_controller.
|
java.lang.String |
getUuid(Connection c)
Get the uuid field of the given SDN_controller.
|
int |
hashCode() |
static SDNController |
introduce(Connection c,
Types.SdnControllerProtocol protocol,
java.lang.String address,
java.lang.Long port)
Introduce an SDN controller to the pool.
|
static Task |
introduceAsync(Connection c,
Types.SdnControllerProtocol protocol,
java.lang.String address,
java.lang.Long port)
Introduce an SDN controller to the pool.
|
java.lang.String |
toWireString() |
isNull
protected final java.lang.String ref
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 SDNController.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static SDNController getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onuuid
- UUID of object to returnTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Types.SdnControllerProtocol getProtocol(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getAddress(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Long getPort(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static Task introduceAsync(Connection c, Types.SdnControllerProtocol protocol, java.lang.String address, java.lang.Long port) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onprotocol
- Protocol to connect with the controller.address
- IP address of the controller.port
- TCP port of the controller.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static SDNController introduce(Connection c, Types.SdnControllerProtocol protocol, java.lang.String address, java.lang.Long port) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onprotocol
- Protocol to connect with the controller.address
- IP address of the controller.port
- TCP port of the controller.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static java.util.Set<SDNController> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static java.util.Map<SDNController,SDNController.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.