Class: OpenNebula::Pool

Inherits:

XMLPool

• Object
• XMLElement
• XMLPool
• OpenNebula::Pool

Includes:

Enumerable

Defined in:

lib/opennebula/pool.rb

Overview

The Pool class represents a generic OpenNebula Pool in XML format and provides the basic functionality to handle the Pool elements

Direct Known Subclasses

AclPool, ClusterPool, DatastorePool, DocumentPool, GroupPool, HostPool, ImagePool, MarketPlaceAppPool, MarketPlacePool, SecurityGroupPool, TemplatePool, UserPool, VMGroupPool, VdcPool, VirtualMachinePool, VirtualNetworkPool, VirtualRouterPool, ZonePool

Constant Summary

PAGINATED_POOLS =

%w{VM_POOL IMAGE_POOL TEMPLATE_POOL VN_POOL
DOCUMENT_POOL SECGROUP_POOL}

INFO_GROUP =

Constants for info queries (include/RequestManagerPoolInfoFilter.h)

-1

INFO_ALL =

-2

INFO_MINE =

-3

INFO_PRIMARY_GROUP =

-4

Instance Method Summary

• #each(&block) ⇒ Object

  Iterates over every PoolElement in the Pool and calls the block with a a PoolElement obtained calling the factory method block

  Block.

• #each_with_xpath ⇒ Object
• #get_hash(size = nil) ⇒ Object

  Gets a hash from a pool.

• #info_paginated(size) ⇒ Object

  Gets a pool in hash form using pagination.

• #to_str ⇒ Object

  DO NOT USE - ONLY REXML BACKEND.

Methods inherited from XMLPool

#each_element

Methods inherited from XMLElement

#[], #add_element, #attr, build_xml, #delete_element, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #retrieve_xmlelements, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml, #xml_nil?

Instance Method Details

#each(&block) ⇒ Object

Iterates over every PoolElement in the Pool and calls the block with a a PoolElement obtained calling the factory method

block

Block

# File 'lib/opennebula/pool.rb', line 156

def each(&block)
    each_element(block) if @xml
end

#each_with_xpath ⇒ Object

# File 'lib/opennebula/pool.rb', line 25

alias_method :each_with_xpath, :each

#get_hash(size = nil) ⇒ Object

Gets a hash from a pool

size

nil => default page size < 2 => not paginated >=2 => page size

The default page size can be changed with the environment variable ONE_POOL_PAGE_SIZE. Any value > 2 will set a page size, a non numeric value disables pagination.

# File 'lib/opennebula/pool.rb', line 177

def get_hash(size=nil)
    allow_paginated = PAGINATED_POOLS.include?(@pool_name)

    if OpenNebula.pool_page_size && allow_paginated &&
            ( ( size && size >= 2 ) || !size )
        size = OpenNebula.pool_page_size if !size
        hash=info_paginated(size)

        return hash if OpenNebula.is_error?(hash)
        { @pool_name => { @element_name => hash } }
    else
        rc=info
        return rc if OpenNebula.is_error?(rc)
        to_hash
    end
end

#info_paginated(size) ⇒ Object

Gets a pool in hash form using pagination

size

Integer size of each page

# File 'lib/opennebula/pool.rb', line 197

def info_paginated(size)
    array=Array.new
    current=0

    parser=ParsePoolSax.new(@pool_name, @element_name)

    while true
        a=@client.call("#{@pool_name.delete('_').downcase}.info",
            @user_id, current, -size, -1)
        return a if OpenNebula.is_error?(a)

        a_array=parser.parse(a)

        array   += a_array
        current += size

        break if !a || a_array.length<size
    end

    array.compact!
    array=nil if array.length == 0

    array
end

#to_str ⇒ Object

DO NOT USE - ONLY REXML BACKEND

# File 'lib/opennebula/pool.rb', line 161

def to_str
    str = ""
    REXML::Formatters::Pretty.new(1).write(@xml,str)

    return str
end