Package org.opennebula.client.template
Class TemplatePool
java.lang.Object
org.opennebula.client.Pool
org.opennebula.client.template.TemplatePool
This class represents an OpenNebula Template pool.
It also offers static XML-RPC call wrappers.
-
Field Summary
Fields inherited from class org.opennebula.client.Pool
ALL, client, elementName, GROUP, infoMethod, MINE, MINE_GROUP, poolElements, xpath
-
Constructor Summary
ConstructorsConstructorDescriptionTemplatePool
(Client client) Creates a new Template pool with the default filter flag value set toPool.MINE_GROUP
(Template belonging to the connected user, and the ones in his group)TemplatePool
(Client client, int filter) Creates a new Template pool. -
Method Summary
Modifier and TypeMethodDescriptionThe factory method returns a suitable PoolElement object from an XML node.getById
(int id) Returns the Template with the given Id from the pool.info()
Loads the xml representation of all or part of the Templates in the pool.info
(int filter, int startId, int endId) Retrieves all or part of the Templates in the pool.static OneResponse
Retrieves all or part of the Templates in the pool.static OneResponse
Retrieves all or part of the Templates in the pool.infoAll()
Loads the xml representation of all the Templates in the pool.static OneResponse
Retrieves all the Templates in the pool.Loads the xml representation of all the connected user's Templates and the ones in his group.static OneResponse
Retrieves all the connected user's Templates and the ones in his group.infoMine()
Loads the xml representation of all the connected user's Templates.static OneResponse
Retrieves all the connected user's Templates.iterator()
Methods inherited from class org.opennebula.client.Pool
getLength, info, info, infoAll, infoGroup, infoGroupPrimary, infoMine, item, processInfo, xmlrpcInfo
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
TemplatePool
Creates a new Template pool with the default filter flag value set toPool.MINE_GROUP
(Template belonging to the connected user, and the ones in his group)- Parameters:
client
- XML-RPC Client.- See Also:
-
TemplatePool
Creates a new Template pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use by default in the methodinfo()
. Possible values:Pool.ALL
: All TemplatesPool.MINE
: Connected user's TemplatesPool.MINE_GROUP
: Connected user's Templates, and the ones in his groupPool.GROUP
: User's primary group Templates- >= 0: UID User's Templates
-
-
Method Details
-
factory
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
Retrieves all or part of the Templates in the pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use. Possible values:Pool.ALL
: All TemplatesPool.MINE
: Connected user's TemplatesPool.MINE_GROUP
: Connected user's Templates, and the ones in his groupPool.GROUP
: User's primary group Templates- >= 0: UID User's Templates
- >= 0: UID User's Templates
- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoAll
Retrieves all the Templates in the pool.- Parameters:
client
- XML-RPC Client.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoMine
Retrieves all the connected user's Templates.- Parameters:
client
- XML-RPC Client.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoGroup
Retrieves all the connected user's Templates 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
Retrieves all or part of the Templates in the pool. The Templates 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 TemplatesPool.MINE
: Connected user's TemplatesPool.MINE_GROUP
: Connected user's Templates, and the ones in his groupPool.GROUP
: User's primary group Templates- >= 0: UID User's Templates
- >= 0: UID User's Templates
startId
- Lowest Id to retrieveendId
- Biggest Id to retrieve- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
info
Loads the xml representation of all or part of the Templates in the pool. The filter used is the one set in the constructor. -
infoAll
Loads the xml representation of all the Templates in the pool. -
infoMine
Loads the xml representation of all the connected user's Templates. -
infoGroup
Loads the xml representation of all the connected user's Templates and the ones in his group. -
info
Retrieves all or part of the Templates in the pool. The Templates 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 TemplatesPool.MINE
: Connected user's TemplatesPool.MINE_GROUP
: Connected user's Templates, and the ones in his groupPool.GROUP
: User's primary group Templates- >= 0: UID User's Templates
- >= 0: UID User's Templates
startId
- Lowest Id to retrieveendId
- Biggest Id to retrieve- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
iterator
-
getById
Returns the Template with the given Id from the pool. If it is not found, then returns null. The methodinfo()
must be called before.
-