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