Package org.opennebula.client.vrouter
Class VirtualRouterPool
java.lang.Object
org.opennebula.client.Pool
org.opennebula.client.vrouter.VirtualRouterPool
- All Implemented Interfaces:
Iterable<VirtualRouter>
This class represents an OpenNebula VirtualRouter 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
ConstructorsConstructorDescriptionVirtualRouterPool
(Client client) Creates a new VirtualRouter pool with the default filter flag value set toPool.MINE_GROUP
(VirtualRouter belonging to the connected user, and the ones in his group)VirtualRouterPool
(Client client, int filter) Creates a new VirtualRouter pool. -
Method Summary
Modifier and TypeMethodDescriptionThe factory method returns a suitable PoolElement object from an XML node.getById
(int id) Returns the VirtualRouter with the given Id from the pool.info()
Loads the xml representation of all or part of the VirtualRouters in the pool.info
(int filter, int startId, int endId) Retrieves all or part of the VirtualRouters in the pool.static OneResponse
Retrieves all or part of the VirtualRouters in the pool.static OneResponse
Retrieves all or part of the VirtualRouters in the pool.infoAll()
Loads the xml representation of all the VirtualRouters in the pool.static OneResponse
Retrieves all the VirtualRouters in the pool.Loads the xml representation of all the connected user's VirtualRouters and the ones in his group.static OneResponse
Retrieves all the connected user's VirtualRouters and the ones in his group.infoMine()
Loads the xml representation of all the connected user's VirtualRouters.static OneResponse
Retrieves all the connected user's VirtualRouters.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
-
VirtualRouterPool
Creates a new VirtualRouter pool with the default filter flag value set toPool.MINE_GROUP
(VirtualRouter belonging to the connected user, and the ones in his group)- Parameters:
client
- XML-RPC Client.- See Also:
-
VirtualRouterPool
Creates a new VirtualRouter pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use by default in the methodinfo()
. Possible values:Pool.ALL
: All VirtualRoutersPool.MINE
: Connected user's VirtualRoutersPool.MINE_GROUP
: Connected user's VirtualRouters, and the ones in his groupPool.GROUP
: User's primary group VirtualRouters- >= 0 UID User's VirtualRouters
-
-
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 VirtualRouters in the pool.- Parameters:
client
- XML-RPC Client.filter
- Filter flag to use. Possible values:Pool.ALL
: All VirtualRoutersPool.MINE
: Connected user's VirtualRoutersPool.MINE_GROUP
: Connected user's VirtualRouters, and the ones in his groupPool.GROUP
: User's primary group VirtualRouters- >= 0 UID User's VirtualRouters
- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
infoAll
Retrieves all the VirtualRouters 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 VirtualRouters.- 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 VirtualRouters 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 VirtualRouters in the pool. The VirtualRouters 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 VirtualRoutersPool.MINE
: Connected user's VirtualRoutersPool.MINE_GROUP
: Connected user's VirtualRouters, and the ones in his groupPool.GROUP
: User's primary group VirtualRouters- >= 0 UID User's VirtualRouters
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 VirtualRouters in the pool. The filter used is the one set in the constructor. -
infoAll
Loads the xml representation of all the VirtualRouters in the pool. -
infoMine
Loads the xml representation of all the connected user's VirtualRouters. -
infoGroup
Loads the xml representation of all the connected user's VirtualRouters and the ones in his group. -
info
Retrieves all or part of the VirtualRouters in the pool. The VirtualRouters 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 VirtualRoutersPool.MINE
: Connected user's VirtualRoutersPool.MINE_GROUP
: Connected user's VirtualRouters, and the ones in his groupPool.GROUP
: User's primary group VirtualRouters- >= 0 UID User's VirtualRouters
startId
- Lowest Id to retrieveendId
- Biggest Id to retrieve- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
iterator
- Specified by:
iterator
in interfaceIterable<VirtualRouter>
-
getById
Returns the VirtualRouter with the given Id from the pool. If it is not found, then returns null. The methodinfo()
must be called before.
-