Package org.opennebula.client.image
Class ImagePool
- java.lang.Object
-
- org.opennebula.client.Pool
-
- org.opennebula.client.image.ImagePool
-
-
Field Summary
-
Fields inherited from class org.opennebula.client.Pool
ALL, client, elementName, GROUP, infoMethod, MINE, MINE_GROUP, poolElements, xpath
-
-
Constructor Summary
Constructors Constructor Description ImagePool(Client client)
Creates a new Image pool with the default filter flag value set toPool.MINE_GROUP
(Images belonging to the connected user, and the ones in his group)ImagePool(Client client, int filter)
Creates a new Image pool.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PoolElement
factory(org.w3c.dom.Node node)
The factory method returns a suitable PoolElement object from an XML node.Image
getById(int id)
Returns the Image with the given Id from the pool.OneResponse
info()
Loads the xml representation of all or part of the Images in the pool.OneResponse
info(int filter, int startId, int endId)
Retrieves all or part of the Images in the pool.static OneResponse
info(Client client, int filter)
Retrieves all or part of the Images in the pool.static OneResponse
info(Client client, int filter, int startId, int endId)
Retrieves all or part of the Images in the pool.OneResponse
infoAll()
Loads the xml representation of all the Images in the pool.static OneResponse
infoAll(Client client)
Retrieves all the Images in the pool.OneResponse
infoGroup()
Loads the xml representation of all the connected user's Images and the ones in his group.static OneResponse
infoGroup(Client client)
Retrieves all the connected user's Images and the ones in his group.OneResponse
infoMine()
Loads the xml representation of all the connected user's Images.static OneResponse
infoMine(Client client)
Retrieves all the connected user's Images.java.util.Iterator<Image>
iterator()
-
Methods inherited from class org.opennebula.client.Pool
getLength, info, info, infoAll, infoGroup, infoGroupPrimary, infoMine, item, processInfo, xmlrpcInfo
-
-
-
-
Constructor Detail
-
ImagePool
public ImagePool(Client client)
Creates a new Image pool with the default filter flag value set toPool.MINE_GROUP
(Images belonging to the connected user, and the ones in his group)- Parameters:
client
- XML-RPC Client.- See Also:
ImagePool(Client, int)
-
ImagePool
public ImagePool(Client client, int filter)
Creates a new Image pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use by default in the methodinfo()
. Possible values:Pool.ALL
: All ImagesPool.MINE
: Connected user's ImagesPool.MINE_GROUP
: Connected user's Images, and the ones in his groupPool.GROUP
: User's primary group Images- >= 0 UID User's Images
-
-
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.
-
info
public static OneResponse info(Client client, int filter)
Retrieves all or part of the Images in the pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use. Possible values:Pool.ALL
: All ImagesPool.MINE
: Connected user's ImagesPool.MINE_GROUP
: Connected user's Images, and the ones in his groupPool.GROUP
: User's primary group Images- >= 0 UID User's Images
- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoAll
public static OneResponse infoAll(Client client)
Retrieves all the Images in the pool.- Parameters:
client
- XML-RPC Client.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoMine
public static OneResponse infoMine(Client client)
Retrieves all the connected user's Images.- Parameters:
client
- XML-RPC Client.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoGroup
public static OneResponse infoGroup(Client client)
Retrieves all the connected user's Images and the ones in his group.- Parameters:
client
- XML-RPC Client.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
info
public static OneResponse info(Client client, int filter, int startId, int endId)
Retrieves all or part of the Images in the pool. The Images to retrieve can be also filtered by Id, specifying the first and last Id to include.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use. Possible values:Pool.ALL
: All ImagesPool.MINE
: Connected user's ImagesPool.MINE_GROUP
: Connected user's Images, and the ones in his groupPool.GROUP
: User's primary group Images- >= 0 UID User's Images
startId
- Lowest Id to retrieveendId
- Biggest Id to retrieve- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
info
public OneResponse info()
Loads the xml representation of all or part of the Images in the pool. The filter used is the one set in the constructor.- Overrides:
info
in classPool
- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
- See Also:
info(Client, int)
-
infoAll
public OneResponse infoAll()
Loads the xml representation of all the Images in the pool.
-
infoMine
public OneResponse infoMine()
Loads the xml representation of all the connected user's Images.
-
infoGroup
public OneResponse infoGroup()
Loads the xml representation of all the connected user's Images and the ones in his group.
-
info
public OneResponse info(int filter, int startId, int endId)
Retrieves all or part of the Images in the pool. The Images to retrieve can be also filtered by Id, specifying the first and last Id to include.- Overrides:
info
in classPool
- Parameters:
filter
- Filter flag to use. Possible values:Pool.ALL
: All ImagesPool.MINE
: Connected user's ImagesPool.MINE_GROUP
: Connected user's Images, and the ones in his groupPool.GROUP
: User's primary group Images- >= 0 UID User's Images
startId
- Lowest Id to retrieveendId
- Biggest Id to retrieve- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
iterator
public java.util.Iterator<Image> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<Image>
-
-