Class SecurityGroupPool

java.lang.Object
org.opennebula.client.Pool
org.opennebula.client.secgroup.SecurityGroupPool
All Implemented Interfaces:
Iterable<SecurityGroup>

public class SecurityGroupPool extends Pool implements Iterable<SecurityGroup>
This class represents an OpenNebula Security Group pool. It also offers static XML-RPC call wrappers.
  • Constructor Details

    • SecurityGroupPool

      public SecurityGroupPool(Client client)
      Creates a new Security Group pool with the default filter flag value set to Pool.MINE_GROUP (Security Groups belonging to the connected user, and the ones in his group)
      Parameters:
      client - XML-RPC Client.
      See Also:
    • 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 method info(). Possible values:
      • Pool.ALL: All Security Groups
      • Pool.MINE: Connected user's Security Groups
      • Pool.MINE_GROUP: Connected user's Security Groups, and the ones in his group
      • Pool.GROUP: User's primary group Security Groups
      • >= 0 UID User's Security Groups
  • Method Details

    • factory

      public PoolElement factory(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.
      Specified by:
      factory in class Pool
      Parameters:
      node - XML Dom node to build the PoolElement from
      Returns:
      The corresponding PoolElement
    • 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 Groups
      • Pool.MINE: Connected user's Security Groups
      • Pool.MINE_GROUP: Connected user's Security Groups, and the ones in his group
      • Pool.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 Groups
      • Pool.MINE: Connected user's Security Groups
      • Pool.MINE_GROUP: Connected user's Security Groups, and the ones in his group
      • Pool.GROUP: User's primary group Security Groups
      • >= 0 UID User's Security Groups
      startId - Lowest Id to retrieve
      endId - 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 class Pool
      Returns:
      If successful the message contains the string with the information returned by OpenNebula.
      See Also:
    • infoAll

      public OneResponse infoAll()
      Loads the xml representation of all the Security Groups in the pool.
      Overrides:
      infoAll in class Pool
      Returns:
      If successful the message contains the string with the information returned by OpenNebula.
    • infoMine

      public OneResponse infoMine()
      Loads the xml representation of all the connected user's Security Groups.
      Overrides:
      infoMine in class Pool
      Returns:
      If successful the message contains the string with the information returned by OpenNebula.
    • infoGroup

      public OneResponse infoGroup()
      Loads the xml representation of all the connected user's Security Groups and the ones in his group.
      Overrides:
      infoGroup in class Pool
      Returns:
      If successful the message contains the string with the information returned by OpenNebula.
    • 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 class Pool
      Parameters:
      filter - Filter flag to use. Possible values:
      • Pool.ALL: All Security Groups
      • Pool.MINE: Connected user's Security Groups
      • Pool.MINE_GROUP: Connected user's Security Groups, and the ones in his group
      • Pool.GROUP: User's primary group Security Groups
      • >= 0 UID User's Security Groups
      startId - Lowest Id to retrieve
      endId - Biggest Id to retrieve
      Returns:
      If successful the message contains the string with the information returned by OpenNebula.
    • iterator

      public Iterator<SecurityGroup> iterator()
      Specified by:
      iterator in interface 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 method info() must be called before.
      Overrides:
      getById in class Pool
      Parameters:
      id - of the Security Group to retrieve
      Returns:
      The Image with the given Id, or null if it was not found.