Package org.opennebula.client.document
Class DocumentPool
java.lang.Object
org.opennebula.client.Pool
org.opennebula.client.document.DocumentPool
This class represents an OpenNebula Document pool.
Documents are generic objects. You can dynamically create new Pools in OpenNebula, creating subclasses with different TYPE values.TYPE must be the same for the corresponding pool element, see
Document
For example:
public class GenericObjAPool extends DocumentPool implements Iterable<GenericObjA>
{
private static final int TYPE = 200;
protected int type()
{
return TYPE;
}
public GenericObjAPool(Client client)
{
super(client);
}
public GenericObjAPool(Client client, int filter)
{
super(client, filter);
}
public GenericObjA factory(Node node)
{
return new GenericObjA(node, client);
}
public Iterator<GenericObjA> iterator()
{
AbstractList<GenericObjA> ab = new AbstractList<GenericObjA>()
{
public int size()
{
return getLength();
}
public GenericObjA get(int index)
{
return (GenericObjA) item(index);
}
};
return ab.iterator();
}
}
-
Field Summary
Fields inherited from class org.opennebula.client.Pool
ALL, client, elementName, GROUP, infoMethod, MINE, MINE_GROUP, poolElements, xpath
-
Constructor Summary
ConstructorsConstructorDescriptionDocumentPool
(Client client) Creates a new Document pool with the default filter flag value set toPool.MINE_GROUP
(Document belonging to the connected user, and the ones in his group)DocumentPool
(Client client, int filter) Creates a new Document pool. -
Method Summary
Modifier and TypeMethodDescriptiongetById
(int id) Returns the Document with the given Id from the pool.info()
Loads the xml representation of all or part of the Documents in the pool.info
(int filter, int startId, int endId) Retrieves all or part of the Documents in the pool.infoAll()
Loads the xml representation of all the Documents in the pool.Loads the xml representation of all the connected user's Documents and the ones in his group.infoMine()
Loads the xml representation of all the connected user's Documents.protected abstract int
type()
Methods inherited from class org.opennebula.client.Pool
factory, getLength, info, info, infoAll, infoGroup, infoGroupPrimary, infoMine, item, processInfo, xmlrpcInfo
-
Constructor Details
-
DocumentPool
Creates a new Document pool with the default filter flag value set toPool.MINE_GROUP
(Document belonging to the connected user, and the ones in his group)- Parameters:
client
- XML-RPC Client.- See Also:
-
DocumentPool
Creates a new Document pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use by default in the methodinfo()
. Possible values:Pool.ALL
: All DocumentsPool.MINE
: Connected user's DocumentsPool.MINE_GROUP
: Connected user's Documents, and the ones in his groupPool.GROUP
: User's primary group Documents- >= 0 UID User's Documents
-
-
Method Details
-
type
protected abstract int type() -
info
Loads the xml representation of all or part of the Documents in the pool. The filter used is the one set in the constructor. -
infoAll
Loads the xml representation of all the Documents in the pool. -
infoMine
Loads the xml representation of all the connected user's Documents. -
infoGroup
Loads the xml representation of all the connected user's Documents and the ones in his group. -
info
Retrieves all or part of the Documents in the pool. The Documents 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 DocumentsPool.MINE
: Connected user's DocumentsPool.MINE_GROUP
: Connected user's Documents, and the ones in his groupPool.GROUP
: User's primary group Documents- >= 0 UID User's Documents
startId
- Lowest Id to retrieveendId
- Biggest Id to retrieve- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
getById
Returns the Document with the given Id from the pool. If it is not found, then returns null. The methodinfo()
must be called before.
-