org.opennebula.client.cluster
Class ClusterPool

java.lang.Object
  org.opennebula.client.Pool
      org.opennebula.client.cluster.ClusterPool

All Implemented Interfaces:

java.lang.Iterable<Cluster>

public class ClusterPool
extends Pool
implements java.lang.Iterable<Cluster>

This class represents an OpenNebula cluster pool. It also offers static XML-RPC call wrappers.

Field Summary

static int

NONE_CLUSTER_ID

Fields inherited from class org.opennebula.client.Pool

ALL, client, elementName, infoMethod, MINE, MINE_GROUP, poolElements

Constructor Summary

ClusterPool(Client client)
Creates a new cluster pool

Method Summary

PoolElement	factory(org.w3c.dom.Node node) The factory method returns a suitable PoolElement object from an XML node.
Cluster	getById(int id) Returns the Cluster with the given Id from the pool.
OneResponse	info() Loads the xml representation of the cluster pool.
static OneResponse	info(Client client) Retrieves all the clusters in the pool.
java.util.Iterator<Cluster>	iterator()

Methods inherited from class org.opennebula.client.Pool

getLength, info, info, info, infoAll, infoAll, infoGroup, infoGroup, infoMine, infoMine, item, processInfo, xmlrpcInfo

Methods inherited from class java.lang.Object

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

Field Detail

NONE_CLUSTER_ID

public static final int NONE_CLUSTER_ID

See Also:

Constant Field Values

Constructor Detail

ClusterPool

public ClusterPool(Client client)

Creates a new cluster pool

Parameters:

client - XML-RPC Client.

Method Detail

factory

public PoolElement factory(org.w3c.dom.Node node)

Description copied from class: Pool

The factory method returns a suitable PoolElement object from an XML node. Each Pool must implement the corresponding factory method.

Specified by:

factory in class Pool

Parameters:

node - XML Dom node to build the PoolElement from

Returns:

The corresponding PoolElement

info

public static OneResponse info(Client client)

Retrieves all the clusters in the pool.

Parameters:

client - XML-RPC Client.

Returns:

If successful the message contains the string with the information returned by OpenNebula.

info

public OneResponse info()

Loads the xml representation of the cluster pool.

Overrides:

info in class Pool

See Also:

info(Client)

iterator

public java.util.Iterator<Cluster> iterator()

Specified by:

iterator in interface java.lang.Iterable<Cluster>

getById

public Cluster getById(int id)

Returns the Cluster with the given Id from the pool. If it is not found, then returns null. The method info() must be called before.

Overrides:

getById in class Pool

Parameters:

id - of the Cluster to retrieve

Returns:

The Image with the given Id, or null if it was not found.