Files
one/src/oca/ruby/OpenNebula/Pool.rb
T

407 lines
15 KiB
Ruby

# -------------------------------------------------------------------------- #
# Copyright 2002-2012, 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
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, *args)
return xmlrpc_info(xml_method,INFO_ALL,-1,-1, *args)
end
def info_mine(xml_method, *args)
return xmlrpc_info(xml_method,INFO_MINE,-1,-1, *args)
end
def info_group(xml_method, *args)
return xmlrpc_info(xml_method,INFO_GROUP,-1,-1, *args)
end
def info_filter(xml_method, who, start_id, end_id, *args)
return xmlrpc_info(xml_method,who, start_id, end_id, *args)
end
# Retrieves the monitoring data for all the Objects in the pool
#
# @param [String] xml_method xml-rcp method
# @param [String] root_elem Root for each individual PoolElement
# @param [String] timestamp_elem Name of the XML element with the last
# monitorization timestamp
# @param [Array<String>] xpath_expressions Elements to retrieve.
# @param args arguemnts for the xml_method call
#
# @return [Hash<String, <Hash<String, Array<Array<int>>>>>,
# OpenNebula::Error] The first level hash uses the Object ID as keys,
# and as value a Hash with the requested xpath expressions,
# and an Array of 'timestamp, value'.
def monitoring(xml_method, root_elem, timestamp_elem, xpath_expressions,
*args)
rc = @client.call(xml_method, *args)
if ( OpenNebula.is_error?(rc) )
return rc
end
xmldoc = XMLElement.new
xmldoc.initialize_xml(rc, 'MONITORING_DATA')
hash = {}
# Get all existing Object IDs
ids = xmldoc.retrieve_elements("#{root_elem}/ID")
if ids.nil?
return hash
else
ids.uniq!
end
ids.each { |id|
hash[id] = OpenNebula.process_monitoring(
xmldoc, root_elem, timestamp_elem, id, xpath_expressions)
}
return hash
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
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
#######################################################################
# Common client call wrapper. Checks that @pe_id is defined, and
# returns nil instead of the response if it is successful
#
# @param [String] xml_method xml-rpc method
# @param [Array] args any arguments for the xml-rpc method
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def call(xml_method, *args)
return Error.new('ID not defined') if !@pe_id
rc = @client.call(xml_method, *args)
rc = nil if !OpenNebula.is_error?(rc)
return rc
end
# Calls to the corresponding info method to retreive the element
# detailed information in XML format
#
# @param [String] xml_method the name of the XML-RPC method
# @param [String] root_element Base XML element name
# @param [Array] args additional arguments
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
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
#
# @param [String] xml_method the name of the XML-RPC method
# @param [Array] args any extra arguments for the xml-rpc method
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
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
#
# @param [String] xml_method the name of the XML-RPC method
# @param [String] new_template the new template contents
# @param [Array] args any extra arguments for the xml-rpc method
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def update(xml_method, new_template, *args)
new_template ||= template_xml
return call(xml_method, @pe_id, new_template, *args)
end
# Calls to the corresponding delete method to remove this element
# from the OpenNebula core
#
# @param [String] xml_method the name of the XML-RPC method
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def delete(xml_method)
return call(xml_method,@pe_id)
end
# Calls to the corresponding chown method to modify
# the object's owner and group
#
# @param [String] xml_method the name of the XML-RPC method
# @param [Integer] uid the new owner id. Set to -1 to leave the current one
# @param [Integer] gid the new goup id. Set to -1 to leave the current one
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def chown(xml_method, uid, gid)
return call(xml_method, @pe_id, uid, gid)
end
# Calls to the corresponding chmod method to modify
# the object's permission bits
#
# @param xml_method [String] the name of the XML-RPC method
# @param octet [String] Permissions octed , e.g. 640
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def chmod_octet(xml_method, octet)
owner_u = octet[0..0].to_i & 4 != 0 ? 1 : 0
owner_m = octet[0..0].to_i & 2 != 0 ? 1 : 0
owner_a = octet[0..0].to_i & 1 != 0 ? 1 : 0
group_u = octet[1..1].to_i & 4 != 0 ? 1 : 0
group_m = octet[1..1].to_i & 2 != 0 ? 1 : 0
group_a = octet[1..1].to_i & 1 != 0 ? 1 : 0
other_u = octet[2..2].to_i & 4 != 0 ? 1 : 0
other_m = octet[2..2].to_i & 2 != 0 ? 1 : 0
other_a = octet[2..2].to_i & 1 != 0 ? 1 : 0
chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
other_m, other_a)
end
# Calls to the corresponding chmod method to modify
# the object's permission bits
# Each [Integer] parameter must be 1 to allow, 0 deny, -1 do not change
#
# @param xml_method [String] the name of the XML-RPC method
#
# @return [nil, OpenNebula::Error] nil in case of success, Error
# otherwise
def chmod(xml_method, owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
other_m, other_a)
return call(xml_method, @pe_id, owner_u, owner_m,
owner_a, group_u, group_m, group_a, other_u,
other_m, other_a)
end
# Retrieves this Element's monitoring data from OpenNebula
#
# @param [String] xml_method the name of the XML-RPC method
# @param [String] root_elem Root for each individual PoolElement
# @param [String] timestamp_elem Name of the XML element with the last
# monitorization timestamp
# @param xpath_expressions [Array<String>] Xpath expressions for the
# elements to retrieve.
#
# @return [Hash<String, Array<Array<int>>, OpenNebula::Error] Hash with
# the requested xpath expressions, and an Array of [timestamp, value].
def monitoring(xml_method, root_elem, timestamp_elem, xpath_expressions)
return Error.new('ID not defined') if !@pe_id
rc = @client.call(xml_method, @pe_id)
if ( OpenNebula.is_error?(rc) )
return rc
end
xmldoc = XMLElement.new
xmldoc.initialize_xml(rc, 'MONITORING_DATA')
return OpenNebula.process_monitoring(
xmldoc, root_elem, timestamp_elem, @pe_id, xpath_expressions)
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
# Processes the monitoring data in XML returned by OpenNebula
#
# @param [XMLElement] xmldoc monitoring data returned by OpenNebula
# @param [String] root_elem Root for each individual PoolElement
# @param [String] timestamp_elem Name of the XML element with the last
# monitorization timestamp
# @param [Integer] Id of the object to process
# @param [Array<String>] xpath_expressions Elements to retrieve.
# @param args arguemnts for the xml_method call
#
# @return [Hash<String, Array<Array<int>>, OpenNebula::Error] Hash with
# the requested xpath expressions, and an Array of [timestamp, value].
def self.process_monitoring(xmldoc, root_elem, timestamp_elem, oid, xpath_expressions)
hash = {}
timestamps = xmldoc.retrieve_elements(
"#{root_elem}[ID=#{oid}]/#{timestamp_elem}")
xpath_expressions.each { |xpath|
xpath_values = xmldoc.retrieve_elements("#{root_elem}[ID=#{oid}]/#{xpath}")
if ( xpath_values.nil? )
hash[xpath] = []
else
hash[xpath] = timestamps.zip(xpath_values)
end
}
return hash
end
end