Package org.opennebula.client.secgroup
Class SecurityGroupPool
- java.lang.Object
-
- org.opennebula.client.Pool
-
- org.opennebula.client.secgroup.SecurityGroupPool
-
- All Implemented Interfaces:
java.lang.Iterable<SecurityGroup>
public class SecurityGroupPool extends Pool implements java.lang.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
Constructors Constructor Description SecurityGroupPool(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
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.SecurityGroup
getById(int id)
Returns the Security Group with the given Id from the pool.OneResponse
info()
Loads the xml representation of all or part of the Security Groups in the pool.OneResponse
info(int filter, int startId, int endId)
Retrieves all or part of the Security Groups in the pool.static OneResponse
info(Client client, int filter)
Retrieves all or part of the Security Groups in the pool.static OneResponse
info(Client client, int filter, int startId, int endId)
Retrieves all or part of the Security Groups in the pool.OneResponse
infoAll()
Loads the xml representation of all the Security Groups in the pool.static OneResponse
infoAll(Client client)
Retrieves all the Security Groups in the pool.OneResponse
infoGroup()
Loads the xml representation of all the connected user's Security Groups and the ones in his group.static OneResponse
infoGroup(Client client)
Retrieves all the connected user's Security Groups and the ones in his group.OneResponse
infoMine()
Loads the xml representation of all the connected user's Security Groups.static OneResponse
infoMine(Client client)
Retrieves all the connected user's Security Groups.java.util.Iterator<SecurityGroup>
iterator()
-
Methods inherited from class org.opennebula.client.Pool
getLength, info, info, infoAll, infoGroup, infoGroupPrimary, infoMine, item, processInfo, xmlrpcInfo
-
-
-
-
Constructor Detail
-
SecurityGroupPool
public SecurityGroupPool(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)- Parameters:
client
- XML-RPC Client.- See Also:
SecurityGroupPool(Client, int)
-
SecurityGroupPool
public SecurityGroupPool(Client client, int filter)
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 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 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
public static OneResponse infoAll(Client client)
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
public static OneResponse infoMine(Client client)
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
public static OneResponse infoGroup(Client client)
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
public static OneResponse info(Client client, int filter, int startId, int endId)
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
public OneResponse 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.- 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 Security Groups in the pool.
-
infoMine
public OneResponse infoMine()
Loads the xml representation of all the connected user's Security Groups.
-
infoGroup
public OneResponse infoGroup()
Loads the xml representation of all the connected user's Security Groups and the ones in his group.
-
info
public OneResponse info(int filter, int startId, int endId)
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
public java.util.Iterator<SecurityGroup> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<SecurityGroup>
-
getById
public SecurityGroup getById(int id)
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.
-
-