This is the base class for all the services of the SDK. It contains the utility methods used by all of them.
Creates a new implementation of the service.
@param parent [Service, Connection] The parent of this service. For most services the parent will be another
service. For example, for the `vm` service that manages virtual machine `123` the parent will be the `vms` service that manages the collection of virtual machines. For the root of the services tree the parent will be the connection.
@param path [String] The path of this service, relative to its parent. For example, the path of the `vm`
service that manages virtual machine `123` will be `vm/123`.
@api private
# File lib/ovirtsdk4/service.rb, line 67 def initialize(parent, path) @parent = parent @path = path end
Reads the response body and checks if it is an action or a fault. If it is an action it checks if the action contains a nested fault. If there is a fault then converts it to an `Error` and raises it. If there is no fault then the action object is returned.
This method is intended for internal use by other components of the SDK. Refrain from using it directly, as backwards compatibility isn't guaranteed.
@api private
# File lib/ovirtsdk4/service.rb, line 96 def check_action(response) body = internal_read_body(response) connection.raise_error(response, body) if body.is_a?(Fault) if body.is_a?(Action) return body if body.fault.nil? connection.raise_error(response, body.fault) end raise Error, "Expected an action or a fault, but got '#{body.class.name.split('::').last}'" end
Reads the response body, checks if it is a fault and if so converts it to an Error and raises it.
This method is intended for internal use by other components of the SDK. Refrain from using it directly, as backwards compatibility isn't guaranteed.
@api private
# File lib/ovirtsdk4/service.rb, line 80 def check_fault(response) body = internal_read_body(response) connection.raise_error(response, body) if body.is_a?(Fault) raise Error, "Expected a fault, but got '#{body.class.name.split('::').last}'" end
Returns the connection used by this service.
This method is intended for internal use by other components of the SDK. Refrain from using it directly, as backwards compatibility isn't guaranteed.
@return [Connection] The connection used by this service.
@api private
# File lib/ovirtsdk4/service.rb, line 116 def connection return @parent if @parent.is_a? Connection @parent.connection end
Returns the absolute path of this service.
@return [String] The absolute path of this service. For example, the path of the `vm` service that manages
virtual machine `123` will be `vms/123`. Note that this absolute path doesn't include the `/ovirt-engine/api/' prefix.
@api private
# File lib/ovirtsdk4/service.rb, line 364 def absolute_path return @path if @parent.is_a? Connection "#{@parent.relative_path}/#{@path}" end
Executes an action method.
@param name [Symbol] The name of the action, for example `:start`. @param member [Symbol] The name of the action member that contains the result. For example `:is_attached`. Can
be `nil` if the action doesn't return any value.
@param opts [Hash] The hash containing the parameters of the action.
@api private
# File lib/ovirtsdk4/service.rb, line 292 def internal_action(name, member, opts) headers = opts[:headers] || {} query = opts[:query] || {} timeout = opts[:timeout] wait = opts[:wait] wait = true if wait.nil? action = Action.new(opts) request = HttpRequest.new request.method = :POST request.url = "#{absolute_path}/#{name}" request.headers = headers request.query = query request.body = Writer.write(action, indent: true) request.timeout = timeout connection.send(request) result = Future.new(self, request) do |response| raise response if response.is_a?(Exception) case response.code when 200, 201, 202 action = check_action(response) action.send(member) if member else check_action(response) end end result = result.wait if wait result end
Executes an `add` method.
@param object [Object] The added object. @param type [Class] Type type of the added object. @param specs [Array<Array<Symbol, Symbol, Class>>] An array of arrays containing the names, tags and types of the
parameters.
@param opts [Hash] The hash containing the values of the parameters.
@api private
# File lib/ovirtsdk4/service.rb, line 173 def internal_add(object, type, specs, opts) object = type.new(object) if object.is_a?(Hash) headers = opts[:headers] || {} query = opts[:query] || {} timeout = opts[:timeout] wait = opts[:wait] wait = true if wait.nil? specs.each do |name, kind| value = opts[name] query[name] = Writer.render(value, kind) if value end request = HttpRequest.new request.method = :POST request.url = absolute_path request.headers = headers request.query = query request.body = Writer.write(object, indent: true) request.timeout = timeout connection.send(request) result = Future.new(self, request) do |response| raise response if response.is_a?(Exception) case response.code when 200, 201, 202 internal_read_body(response) else check_fault(response) end end result = result.wait if wait result end
Executes a `get` method.
@param specs [Array<Array<Symbol, Symbol, Class>>] An array of arrays containing the names, tags and types of the
parameters.
@param opts [Hash] The hash containing the values of the parameters.
@api private
# File lib/ovirtsdk4/service.rb, line 132 def internal_get(specs, opts) headers = opts[:headers] || {} query = opts[:query] || {} timeout = opts[:timeout] wait = opts[:wait] wait = true if wait.nil? specs.each do |name, kind| value = opts[name] query[name] = Writer.render(value, kind) if value end request = HttpRequest.new request.method = :GET request.url = absolute_path request.headers = headers request.query = query request.timeout = timeout connection.send(request) result = Future.new(self, request) do |response| raise response if response.is_a?(Exception) case response.code when 200 internal_read_body(response) else check_fault(response) end end result = result.wait if wait result end
Checks the content type of the given response, and if it is XML, as expected, reads the body and converts it to an object. If it isn't XML, then it raises an exception.
@param response [HttpResponse] The HTTP response to check. @return [Object] The result of converting the HTTP response body from XML to an SDK object.
@api private
# File lib/ovirtsdk4/service.rb, line 330 def internal_read_body(response) # First check if the response body is empty, as it makes no sense to check the content type if there is # no body: connection.raise_error(response, nil) if response.body.nil? || response.body.length.zero? # Check the content type, as otherwise the parsing will fail, and the resulting error message won't be explicit # about the cause of the problem: connection.check_xml_content_type(response) # Parse the XML and generate the SDK object: Reader.read(response.body) end
Executes a `remove` method.
@param specs [Array<(Symbol, Symbol, Class)>] An array of tuples containing the names, tags and types of the
parameters.
@param opts [Hash] The hash containing the values of the parameters.
@api private
# File lib/ovirtsdk4/service.rb, line 257 def internal_remove(specs, opts) headers = opts[:headers] || {} query = opts[:query] || {} timeout = opts[:timeout] wait = opts[:wait] wait = true if wait.nil? specs.each do |name, kind| value = opts[name] query[name] = Writer.render(value, kind) if value end request = HttpRequest.new request.method = :DELETE request.url = absolute_path request.headers = headers request.query = query request.timeout = timeout connection.send(request) result = Future.new(self, request) do |response| raise response if response.is_a?(exception) check_fault(response) unless response.code == 200 end result = result.wait if wait result end
Executes an `update` method.
@param object [Object] The updated object. @param type [Class] Type type of the updated object. @param specs [Array<(Symbol, Symbol, Class)>] An array of tuples containing the names, tags and types of the
parameters.
@param opts [Hash] The hash containing the values of the parameters.
@api private
# File lib/ovirtsdk4/service.rb, line 216 def internal_update(object, type, specs, opts) object = type.new(object) if object.is_a?(Hash) headers = opts[:headers] || {} query = opts[:query] || {} timeout = opts[:timeout] wait = opts[:wait] wait = true if wait.nil? specs.each do |name, kind| value = opts[name] query[name] = Writer.render(value, kind) if value end request = HttpRequest.new request.method = :PUT request.url = absolute_path request.headers = headers request.query = query request.body = Writer.write(object, indent: true) request.timeout = timeout connection.send(request) result = Future.new(self, request) do |response| raise response if response.is_a?(Exception) case response.code when 200 internal_read_body(response) else check_fault(response) end end result = result.wait if wait result end
Returns the relative path of this service.
@return [String] The path of this service, relative to its parent. For example, the path of the `vm`
service that manages virtual machine `123` will be `123`.
@api private
# File lib/ovirtsdk4/service.rb, line 351 def relative_path @path end