public class Message extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
Message.Record
Represents all the fields in a Message
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference (OpaqueRef) to this object.
|
Modifier and Type | Method and Description |
---|---|
static Message |
create(Connection c,
java.lang.String name,
java.lang.Long priority,
Types.Cls cls,
java.lang.String objUuid,
java.lang.String body)
First published in XenServer 5.0.
|
void |
destroy(Connection c)
First published in XenServer 5.0.
|
boolean |
equals(java.lang.Object obj)
If obj is a Message, compares XenAPI references for equality.
|
static java.util.Map<Message,Message.Record> |
get(Connection c,
Types.Cls cls,
java.lang.String objUuid,
java.util.Date since)
First published in XenServer 5.0.
|
static java.util.Set<Message> |
getAll(Connection c)
First published in XenServer 5.0.
|
static java.util.Map<Message,Message.Record> |
getAllRecords(Connection c)
First published in XenServer 5.0.
|
static java.util.Map<Message,Message.Record> |
getAllRecordsWhere(Connection c,
java.lang.String expr)
First published in XenServer 5.0.
|
static Message |
getByUuid(Connection c,
java.lang.String uuid)
First published in XenServer 5.0.
|
Message.Record |
getRecord(Connection c)
First published in XenServer 5.0.
|
static java.util.Map<Message,Message.Record> |
getSince(Connection c,
java.util.Date since)
First published in XenServer 5.0.
|
int |
hashCode() |
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 static Message create(Connection c, java.lang.String name, java.lang.Long priority, Types.Cls cls, java.lang.String objUuid, java.lang.String body) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onname
- The name of the messagepriority
- The priority of the messagecls
- The class of object this message is associated withobjUuid
- The uuid of the object this message is associated withbody
- The body of the messageTypes.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 destroy(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<Message,Message.Record> get(Connection c, Types.Cls cls, java.lang.String objUuid, java.util.Date since) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made oncls
- The class of objectobjUuid
- The uuid of the objectsince
- The cutoff timeTypes.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<Message> 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<Message,Message.Record> getSince(Connection c, java.util.Date since) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onsince
- The cutoff timeTypes.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 Message.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 Message getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onuuid
- The uuid of the messageTypes.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<Message,Message.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.public static java.util.Map<Message,Message.Record> getAllRecordsWhere(Connection c, java.lang.String expr) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onexpr
- The expression to match (not currently used)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.