Package com.xensource.xenapi

Class Message

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Message

public class Message
extends XenAPIObject

A message for the attention of the administrator First published in XenServer 5.0.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Message.Record	Represents all the fields in a Message

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Constructor Summary

Constructors

Constructor	Description
Message(String ref)	Creates an object from a given XenAPI reference (OpaqueRef)

Method Summary

Modifier and Type	Method	Description
static Message	create(Connection c, String name, Long priority, Types.Cls cls, String objUuid, String body)	Minimum allowed role: pool-operator First published in XenServer 5.0.
void	destroy(Connection c)	Minimum allowed role: pool-operator First published in XenServer 5.0.
static void	destroyAll(Connection c, Map<String,String> filters)	Minimum allowed role: pool-operator Experimental.
static Task	destroyAllAsync(Connection c, Map<String,String> filters)	Minimum allowed role: pool-operator Experimental.
static void	destroyMany(Connection c, Set<Message> messages)	Minimum allowed role: pool-operator Experimental.
static Task	destroyManyAsync(Connection c, Set<Message> messages)	Minimum allowed role: pool-operator Experimental.
boolean	equals(Object obj)	If obj is a Message, compares XenAPI references for equality.
static Map<Message,Message.Record>	get(Connection c, Types.Cls cls, String objUuid, Date since)	Minimum allowed role: read-only First published in XenServer 5.0.
static Set<Message>	getAll(Connection c)	Minimum allowed role: read-only First published in XenServer 5.0.
static Map<Message,Message.Record>	getAllRecords(Connection c)	Minimum allowed role: read-only First published in XenServer 5.0.
static Map<Message,Message.Record>	getAllRecordsWhere(Connection c, String expr)	Minimum allowed role: read-only First published in XenServer 5.0.
static Message	getByUuid(Connection c, String uuid)	Minimum allowed role: read-only First published in XenServer 5.0.
Message.Record	getRecord(Connection c)	Minimum allowed role: read-only First published in XenServer 5.0.
static Map<Message,Message.Record>	getSince(Connection c, Date since)	Minimum allowed role: read-only First published in XenServer 5.0.
int	hashCode()
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Constructor Details

Message

public Message(String ref)

Creates an object from a given XenAPI reference (OpaqueRef)

Parameters:

ref - The OpaqueRef from which to create the object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a Message, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

public static Message create(Connection c,
 String name,
 Long priority,
 Types.Cls cls,
 String objUuid,
 String body)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-operator First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

name - The name of the message

priority - The priority of the message

cls - The class of object this message is associated with

objUuid - The uuid of the object this message is associated with

body - The body of the message

Returns:

The reference of the created message

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-operator First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyMany

public static void destroyMany(Connection c,
 Set<Message> messages)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-operator Experimental. First published in 22.19.0.

Parameters:

c - The connection the call is made on

messages - Messages to destroy

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyManyAsync

public static Task destroyManyAsync(Connection c,
 Set<Message> messages)
                             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-operator Experimental. First published in 22.19.0.

Parameters:

c - The connection the call is made on

messages - Messages to destroy

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAll

public static void destroyAll(Connection c,
 Map<String,String> filters)
                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-operator Experimental. First published in 26.6.0.

Parameters:

c - The connection the call is made on

filters - Optional filters identifying messages to destroy: before (RFC3339 DateTime, destroy messages dated before this timestamp), after (RFC3339 DateTime, destroy messages dated after this timestamp), and priority (int, only destroy messages with this priority). All provided conditions must be met (logical AND). If no filters are provided, all messages are destroyed. If no timezone is specified in a timestamp, UTC is assumed.

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAllAsync

public static Task destroyAllAsync(Connection c,
 Map<String,String> filters)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-operator Experimental. First published in 26.6.0.

Parameters:

c - The connection the call is made on

filters - Optional filters identifying messages to destroy: before (RFC3339 DateTime, destroy messages dated before this timestamp), after (RFC3339 DateTime, destroy messages dated after this timestamp), and priority (int, only destroy messages with this priority). All provided conditions must be met (logical AND). If no filters are provided, all messages are destroyed. If no timezone is specified in a timestamp, UTC is assumed.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

get

public static Map<Message,Message.Record> get(Connection c,
 Types.Cls cls,
 String objUuid,
 Date since)
                                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

cls - The class of object

objUuid - The uuid of the object

since - The cutoff time. When the timezone is missing, UTC is assumed

Returns:

The relevant messages

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<Message> getAll(Connection c)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

Returns:

The references to the messages

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getSince

public static Map<Message,Message.Record> getSince(Connection c,
 Date since)
                                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

since - The cutoff time. When the timezone is missing, UTC is assumed

Returns:

The relevant messages

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getRecord

public Message.Record getRecord(Connection c)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

Returns:

The message record

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static Message getByUuid(Connection c,
 String uuid)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

uuid - The uuid of the message

Returns:

The message reference

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<Message,Message.Record> getAllRecords(Connection c)
                                                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

Returns:

The messages

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecordsWhere

public static Map<Message,Message.Record> getAllRecordsWhere(Connection c,
 String expr)
                                                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

expr - The expression to match

Returns:

The messages

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.