oca 3.0.1

data/lib/OpenNebula/HostPool.rb

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class HostPool < Pool
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+        HOST_POOL_METHODS = {
+            :info => "hostpool.info"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+        
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('HOST_POOL','HOST',client)
+        end
+
+        # Factory Method for the Host Pool
+        def factory(element_xml)
+            OpenNebula::Host.new(element_xml,@client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Host Pool 
+        #######################################################################
+
+        # Retrieves all the Hosts in the pool.
+        def info()
+            super(HOST_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/Image.rb

@@ -0,0 +1,214 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+require 'fileutils'
+
+module OpenNebula
+    class Image < PoolElement
+        # ---------------------------------------------------------------------
+        # Constants and Class Methods
+        # ---------------------------------------------------------------------
+        IMAGE_METHODS = {
+            :info        => "image.info",
+            :allocate    => "image.allocate",
+            :update      => "image.update",
+            :enable      => "image.enable",
+            :publish     => "image.publish",
+            :persistent  => "image.persistent",
+            :delete      => "image.delete",
+            :chown       => "image.chown"
+        }
+
+        IMAGE_STATES=%w{INIT READY USED DISABLED LOCKED ERROR}
+
+        SHORT_IMAGE_STATES={
+            "INIT"      => "init",
+            "READY"     => "rdy",
+            "USED"      => "used",
+            "DISABLED"  => "disa",
+            "LOCKED"    => "lock",
+            "ERROR"     => "err"
+        }
+
+        IMAGE_TYPES=%w{OS CDROM DATABLOCK}
+
+        SHORT_IMAGE_TYPES={
+            "OS"         => "OS",
+            "CDROM"      => "CD",
+            "DATABLOCK"  => "DB"
+        }
+
+        # Creates an Image description with just its identifier
+        # this method should be used to create plain Image objects.
+        # +id+ the id of the image
+        #
+        # Example:
+        #   image = Image.new(Image.build_xml(3),rpc_client)
+        #
+        def Image.build_xml(pe_id=nil)
+            if pe_id
+                image_xml = "<IMAGE><ID>#{pe_id}</ID></IMAGE>"
+            else
+                image_xml = "<IMAGE></IMAGE>"
+            end
+
+            XMLElement.build_xml(image_xml,'IMAGE')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+
+            @client = client
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Image Object
+        #######################################################################
+
+        # Retrieves the information of the given Image.
+        def info()
+            super(IMAGE_METHODS[:info], 'IMAGE')
+        end
+
+        # Allocates a new Image in OpenNebula
+        #
+        # +description+ A string containing the template of the Image.
+        def allocate(description)
+            super(IMAGE_METHODS[:allocate],description)
+        end
+
+        # Replaces the template contents
+        #
+        # +new_template+ New template contents
+        def update(new_template)
+            super(IMAGE_METHODS[:update], new_template)
+        end
+
+        # Enables an Image
+        def enable
+            set_enabled(true)
+        end
+
+        # Disables an Image
+        def disable
+            set_enabled(false)
+        end
+
+        # Publishes the Image, to be used by other users
+        def publish
+            set_publish(true)
+        end
+
+        # Unplubishes the Image
+        def unpublish
+            set_publish(false)
+        end
+        
+        # Makes the Image persistent
+        def persistent
+            set_persistent(true)
+        end
+
+        # Makes the Image non persistent
+        def nonpersistent
+            set_persistent(false)
+        end
+
+        # Deletes the Image
+        def delete()
+            super(IMAGE_METHODS[:delete])
+        end
+
+        # Changes the owner/group
+        # uid:: _Integer_ the new owner id. Set to -1 to leave the current one
+        # gid:: _Integer_ the new group id. Set to -1 to leave the current one
+        # [return] nil in case of success or an Error object
+        def chown(uid, gid)
+            super(IMAGE_METHODS[:chown], uid, gid)
+        end
+
+        #######################################################################
+        # Helpers to get Image information
+        #######################################################################
+
+        # Returns the state of the Image (numeric value)
+        def state
+            self['STATE'].to_i
+        end
+
+        # Returns the state of the Image (string value)
+        def state_str
+            IMAGE_STATES[state]
+        end
+
+        # Returns the state of the Image (string value)
+        def short_state_str
+            SHORT_IMAGE_STATES[state_str]
+        end
+
+        # Returns the type of the Image (numeric value)
+        def type
+            self['TYPE'].to_i
+        end
+
+        # Returns the type of the Image (string value)
+        def type_str
+            IMAGE_TYPES[type]
+        end
+
+        # Returns the state of the Image (string value)
+        def short_type_str
+            SHORT_IMAGE_TYPES[type_str]
+        end
+
+        # Returns the group identifier
+        # [return] _Integer_ the element's group ID
+        def gid
+            self['GID'].to_i
+        end
+
+    private
+
+        def set_enabled(enabled)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(IMAGE_METHODS[:enable], @pe_id, enabled)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        def set_publish(published)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(IMAGE_METHODS[:publish], @pe_id, published)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+        
+        def set_persistent(persistence)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(IMAGE_METHODS[:persistent], @pe_id, persistence)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+    end
+end

data/lib/OpenNebula/ImagePool.rb

@@ -0,0 +1,72 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class ImagePool < Pool
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+        
+        IMAGE_POOL_METHODS = {
+            :info => "imagepool.info"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+        
+        # +client+ a Client object that represents a XML-RPC connection
+        # +user_id+ is to refer to a Pool with Images from that user
+        def initialize(client, user_id=-1)
+            super('IMAGE_POOL','IMAGE',client)
+
+            @user_id  = user_id
+        end
+
+        # Default Factory Method for the Pools
+        def factory(element_xml)
+            OpenNebula::Image.new(element_xml,@client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Image Object
+        #######################################################################
+
+        # Retrieves all or part of the VirtualMachines in the pool.
+        def info(*args)
+            case args.size
+                when 0
+                    info_filter(IMAGE_POOL_METHODS[:info],@user_id,-1,-1)
+                when 3
+                    info_filter(IMAGE_POOL_METHODS[:info],args[0],args[1],args[2])
+            end
+        end
+
+        def info_all()
+            return super(IMAGE_POOL_METHODS[:info])
+        end
+
+        def info_mine()
+            return super(IMAGE_POOL_METHODS[:info])
+        end
+
+        def info_group()
+            return super(IMAGE_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/Pool.rb

@@ -0,0 +1,245 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+module OpenNebula
+    # The Pool class represents a generic OpenNebula Pool in XML format
+    # and provides the basic functionality to handle the Pool elements
+    
+    class Pool < XMLPool
+        include Enumerable
+
+    protected
+        #pool:: _String_ XML name of the root element
+        #element:: _String_ XML name of the Pool elements
+        #client::  _Client_ represents a XML-RPC connection
+        def initialize(pool,element,client)
+            super(nil)
+
+            @pool_name    = pool.upcase
+            @element_name = element.upcase
+
+            @client = client
+            @hash   = nil
+        end
+
+        # Default Factory Method for the Pools. The factory method returns an
+        # suitable PoolElement object. Each Pool MUST implement the
+        # corresponding factory method
+        # element_xml:: _XML_ XML element describing the pool element
+        # [return] a PoolElement object
+        def factory(element_xml)
+            OpenNebula::PoolElement.new(element_xml,client)
+        end
+
+        #######################################################################
+        # Common XML-RPC Methods for all the Pool Types
+        #######################################################################
+        
+        #Gets the pool without any filter. Host, Group and User Pools
+        # xml_method:: _String_ the name of the XML-RPC method
+        def info(xml_method)
+            return xmlrpc_info(xml_method)
+        end
+
+        def info_all(xml_method)
+            return xmlrpc_info(xml_method,INFO_ALL,-1,-1)
+        end
+
+        def info_mine(xml_method)
+            return xmlrpc_info(xml_method,INFO_MINE,-1,-1)
+        end
+
+        def info_group(xml_method)
+            return xmlrpc_info(xml_method,INFO_GROUP,-1,-1)
+        end
+    
+        def info_filter(xml_method, who, start_id, end_id)
+            return xmlrpc_info(xml_method,who, start_id, end_id)
+        end
+
+    private
+        # Calls to the corresponding info method to retreive the pool
+        # representation in XML format
+        # xml_method:: _String_ the name of the XML-RPC method
+        # args:: _Array_ with additional arguments for the info call
+        # [return] nil in case of success or an Error object
+        def xmlrpc_info(xml_method,*args)
+            rc = @client.call(xml_method,*args)
+
+            if !OpenNebula.is_error?(rc)
+                initialize_xml(rc,@pool_name)
+                rc   = nil
+            end
+
+            return rc
+        end
+
+    public
+        # Constants for info queries (include/RequestManagerPoolInfoFilter.h)
+        INFO_GROUP = -1
+        INFO_ALL   = -2
+        INFO_MINE  = -3
+
+        # Iterates over every PoolElement in the Pool and calls the block with a
+        # a PoolElement obtained calling the factory method
+        # block:: _Block_
+        def each(&block)
+            each_element(block) if @xml
+        end
+
+        # DO NOT USE - ONLY REXML BACKEND
+        def to_str
+            str = ""
+            REXML::Formatters::Pretty.new(1).write(@xml,str)
+
+            return str
+        end
+    end
+
+    # The PoolElement Class represents a generic element of a Pool in
+    # XML format
+    class PoolElement < XMLElement
+
+    protected
+        # node:: _XML_is a XML element that represents the Pool element
+        # client:: _Client_ represents a XML-RPC connection
+        def initialize(node, client)
+            @xml    = node
+            @client = client
+            @hash   = nil
+
+            if self['ID']
+                @pe_id = self['ID'].to_i
+            else
+                @pe_id = nil
+            end
+            @name = self['NAME'] if self['NAME']
+        end
+
+        #######################################################################
+        # Common XML-RPC Methods for all the Pool Element Types
+        #######################################################################
+
+        # Calls to the corresponding info method to retreive the element
+        # detailed information in XML format
+        # xml_method:: _String_ the name of the XML-RPC method
+        # root_element:: _String_ Base XML element
+        # [return] nil in case of success or an Error object
+        def info(xml_method, root_element)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(xml_method,@pe_id)
+
+            if !OpenNebula.is_error?(rc)
+                initialize_xml(rc, root_element)
+                rc   = nil
+
+                @pe_id = self['ID'].to_i if self['ID']
+                @name  = self['NAME'] if self['NAME']
+            end
+
+            return rc
+        end
+
+        # Calls to the corresponding allocate method to create a new element
+        # in the OpenNebula core
+        # xml_method:: _String_ the name of the XML-RPC method
+        # args:: _Array_ additional arguments including the template for the
+        #                new element
+        # [return] nil in case of success or an Error object
+        def allocate(xml_method, *args)
+            rc = @client.call(xml_method, *args)
+
+            if !OpenNebula.is_error?(rc)
+                @pe_id = rc
+                rc     = nil
+            end
+
+            return rc
+        end
+
+        # Calls to the corresponding update method to modify
+        # the object's template
+        # xml_method:: _String_ the name of the XML-RPC method
+        # new_template:: _String_ the new template contents
+        # [return] nil in case of success or an Error object
+        def update(xml_method, new_template)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(xml_method,@pe_id, new_template)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Calls to the corresponding delete method to remove this element
+        # from the OpenNebula core
+        # xml_method:: _String_ the name of the XML-RPC method
+        # [return] nil in case of success or an Error object
+        def delete(xml_method)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(xml_method,@pe_id)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Calls to the corresponding chown method to modify
+        # the object's owner and group
+        # xml_method:: _String_ the name of the XML-RPC method
+        # uid:: _Integer_ the new owner id. Set to -1 to leave the current one
+        # gid:: _Integer_ the new group id. Set to -1 to leave the current one
+        # [return] nil in case of success or an Error object
+        def chown(xml_method, uid, gid)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(xml_method,@pe_id, uid, gid)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+    public
+
+        # Creates new element specifying its id
+        # id:: identifyier of the element
+        # client:: initialized OpenNebula::Client object
+        def self.new_with_id(id, client=nil)
+            self.new(self.build_xml(id), client)
+        end
+
+        # Returns element identifier
+        # [return] _Integer_ the PoolElement ID
+        def id
+            @pe_id
+        end
+
+        # Gets element name
+        # [return] _String_ the PoolElement name
+        def name
+            @name
+        end
+
+        # DO NOT USE - ONLY REXML BACKEND
+        def to_str
+            str = ""
+            REXML::Formatters::Pretty.new(1).write(@xml,str)
+
+            return str
+        end
+    end
+end