Class UserPool

java.lang.Object
org.opennebula.client.Pool
org.opennebula.client.user.UserPool
All Implemented Interfaces:
Iterable<User>

public class UserPool extends Pool implements Iterable<User>
This class represents an OpenNebula user pool. It also offers static XML-RPC call wrappers.
  • Constructor Details

    • UserPool

      public UserPool(Client client)
      Creates a new user pool
      Parameters:
      client - XML-RPC Client.
  • Method Details

    • factory

      public PoolElement factory(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 users 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 user pool.
      Overrides:
      info in class Pool
    • iterator

      public Iterator<User> iterator()
      Specified by:
      iterator in interface Iterable<User>
    • getById

      public User getById(int id)
      Returns the User 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 User to retrieve
      Returns:
      The Image with the given Id, or null if it was not found.