class OvirtSDK4::PermitsService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 18508
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

add(permit, opts = {}) click to toggle source

Adds a permit to the role. The permit name can be retrieved from the <<services/cluster_levels>> service.

For example to assign a permit `create_vm` to the role with id `123` send a request like this:

.… POST /ovirt-engine/api/roles/123/permits .…

With a request body like this:

source,xml

<permit>

<name>create_vm</name>

</permit>


@param permit [Permit] The permit to add.

@param opts [Hash] Additional options.

@return [Permit]

# File lib/ovirtsdk4/services.rb, line 18537
def add(permit, opts = {})
  if permit.is_a?(Hash)
    permit = OvirtSDK4::Permit.new(permit)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    PermitWriter.write_one(permit, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return PermitReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

List the permits of the role.

For example to list the permits of the role with the id `123` send a request like this:

.… GET /ovirt-engine/api/roles/123/permits .…

source,xml

<permits>

<permit href="/ovirt-engine/api/roles/123/permits/5" id="5">
  <name>change_vm_cd</name>
  <administrative>false</administrative>
  <role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>
<permit href="/ovirt-engine/api/roles/123/permits/7" id="7">
  <name>connect_to_vm</name>
  <administrative>false</administrative>
  <role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>

</permits>


@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of permits to return. If not specified all the permits are returned.

@return [Array<Permit>]

# File lib/ovirtsdk4/services.rb, line 18595
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return PermitReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
permit_service(id) click to toggle source

Sub-resource locator method, returns individual permit resource on which the remainder of the URI is dispatched.

@param id [String] The identifier of the `permit`.

@return [PermitService] A reference to the `permit` service.

# File lib/ovirtsdk4/services.rb, line 18624
def permit_service(id)
  PermitService.new(@connection, "#{@path}/#{id}")
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 18635
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return permit_service(path)
  end
  return permit_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 18651
def to_s
  "#<#{PermitsService}:#{@path}>"
end