com.xensource.xenapi

Class Event

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Event

public class Event
extends XenAPIObject

Asynchronous event registration and handling First published in XenServer 4.0.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) If obj is a Event, compares XenAPI references for equality.
static EventBatch	from(Connection c, java.util.Set<java.lang.String> classes, java.lang.String token, java.lang.Double timeout) Blocking call which returns a new token and a (possibly empty) batch of events.
static java.lang.Long	getCurrentId(Connection c) Return the ID of the next event to be generated by the system First published in XenServer 4.0.
int	hashCode()
static java.lang.String	inject(Connection c, java.lang.String clazz, java.lang.String ref) Injects an artificial event on the given object and returns the corresponding ID in the form of a token, which can be used as a point of reference for database events.
static java.util.Set<Event.Record>	next(Connection c) Deprecated.
static void	register(Connection c, java.util.Set<java.lang.String> classes) Deprecated.
static Task	registerAsync(Connection c, java.util.Set<java.lang.String> classes) Deprecated.
java.lang.String	toWireString()
static void	unregister(Connection c, java.util.Set<java.lang.String> classes) Deprecated.
static Task	unregisterAsync(Connection c, java.util.Set<java.lang.String> classes) Deprecated.

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 Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

registerAsync

@Deprecated
public static Task registerAsync(Connection c,
                            java.util.Set<java.lang.String> classes)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException

Deprecated.

Registers this session with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next. First published in XenServer 4.0.

Parameters:

classes - the classes for which the session will register with the event system; specifying * as the desired class will register for all classes

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

register

@Deprecated
public static void register(Connection c,
                       java.util.Set<java.lang.String> classes)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Deprecated.

Registers this session with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next. First published in XenServer 4.0.

Parameters:

classes - the classes for which the session will register with the event system; specifying * as the desired class will register for all classes

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

unregisterAsync

@Deprecated
public static Task unregisterAsync(Connection c,
                              java.util.Set<java.lang.String> classes)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Deprecated.

Removes this session's registration with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next. First published in XenServer 4.0.

Parameters:

classes - the classes for which the session's registration with the event system will be removed

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

unregister

@Deprecated
public static void unregister(Connection c,
                         java.util.Set<java.lang.String> classes)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Deprecated.

Removes this session's registration with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next. First published in XenServer 4.0.

Parameters:

classes - the classes for which the session's registration with the event system will be removed

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

next

@Deprecated
public static java.util.Set<Event.Record> next(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException,
                                               Types.SessionNotRegistered,
                                               Types.EventsLost

Deprecated.

Blocking call which returns a (possibly empty) batch of events. This method is only recommended for legacy use. New development should use event.from which supercedes this method. First published in XenServer 4.0.

Returns:

A set of events

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SessionNotRegistered

Types.EventsLost

from

public static EventBatch from(Connection c,
              java.util.Set<java.lang.String> classes,
              java.lang.String token,
              java.lang.Double timeout)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException,
                              Types.SessionNotRegistered,
                              Types.EventsLost

Blocking call which returns a new token and a (possibly empty) batch of events. The returned token can be used in subsequent calls to this function. First published in XenServer 6.0.

Parameters:

classes - register for events for the indicated classes

token - A token representing the point from which to generate database events. The empty string represents the beginning.

timeout - Return after this many seconds if no events match

Returns:

a structure consisting of a token ('token'), a map of valid references per object type ('valid_ref_counts'), and a set of event records ('events').

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.SessionNotRegistered

Types.EventsLost

getCurrentId

public static java.lang.Long getCurrentId(Connection c)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException

Return the ID of the next event to be generated by the system First published in XenServer 4.0.

Returns:

the event ID

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

inject

public static java.lang.String inject(Connection c,
                      java.lang.String clazz,
                      java.lang.String ref)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Injects an artificial event on the given object and returns the corresponding ID in the form of a token, which can be used as a point of reference for database events. For example, to check whether an object has reached the right state before attempting an operation, one can inject an artificial event on the object and wait until the token returned by consecutive event.from calls is lexicographically greater than the one returned by event.inject. First published in XenServer 6.1.

Parameters:

clazz - class of the object

ref - A reference to the object that will be changed.

Returns:

the event ID in the form of a token

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException