Class: OpenNebula::Document

Inherits:
PoolElement show all
Defined in:
opennebula/document.rb

Overview

All subclasses must define the DOCUMENT_TYPE constant.

Examples:

require 'opennebula/document'

module OpenNebula
    class CustomObject < Document

        DOCUMENT_TYPE = 400

    end
end

Direct Known Subclasses

DocumentJSON

Constant Summary

DOCUMENT_METHODS =

Constants and Class Methods

{
    :allocate   => "document.allocate",
    :delete     => "document.delete",
    :info       => "document.info",
    :update     => "document.update",
    :chown      => "document.chown",
    :chmod      => "document.chmod",
    :clone      => "document.clone",
    :rename     => "document.rename"
}

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

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

Constructor Details

- (Document) initialize(xml, client)

Class constructor

Examples:

doc = Document.new(Document.build_xml(3),rpc_client)

Parameters:

  • xml (Nokogiri::XML::Node, REXML::Element) —

    string created by the build_xml() method

  • client (OpenNebula::Client) —

    the xml-rpc client



75
76
77
 
# File 'opennebula/document.rb', line 75

def initialize(xml, client)
    super(xml,client)
end

Class Method Details

+ (Nokogiri::XML::Node, REXML::Element) build_xml(pe_id = nil)

Creates a Document Object description with just its identifier this method should be used to create plain Document objects.

Parameters:

  • pe_id (Integer) (defaults to: nil) —

    the id of the object

Returns:

  • (Nokogiri::XML::Node, REXML::Element) —

    the empty xml



55
56
57
58
59
60
61
62
63
 
# File 'opennebula/document.rb', line 55

def Document.build_xml(pe_id=nil)
    if pe_id
        obj_xml = "<DOCUMENT><ID>#{pe_id}</ID></DOCUMENT>"
    else
        obj_xml = "<DOCUMENT></DOCUMENT>"
    end

    XMLElement.build_xml(obj_xml,'DOCUMENT')
end

Instance Method Details

- (nil, OpenNebula::Error) allocate(description)

Allocates a new Document in OpenNebula

Parameters:

  • description (String) —

    The contents of the Document.

Returns:



105
106
107
 
# File 'opennebula/document.rb', line 105

def allocate(description)
    super(DOCUMENT_METHODS[:allocate], description, document_type)
end

- (nil, OpenNebula::Error) chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a)

Changes the Document permissions. Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change

Returns:



167
168
169
170
171
172
173
174
 
# File 'opennebula/document.rb', line 167

def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
        other_m, other_a)
    rc = check_type()
    return rc if OpenNebula.is_error?(rc)

    super(DOCUMENT_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
        group_m, group_a, other_u, other_m, other_a)
end

- (nil, OpenNebula::Error) chmod_octet(octet)

Changes the Document permissions.

Parameters:

  • octet (String) —

    Permissions octed , e.g. 640

Returns:



155
156
157
158
159
160
 
# File 'opennebula/document.rb', line 155

def chmod_octet(octet)
    rc = check_type()
    return rc if OpenNebula.is_error?(rc)

    super(DOCUMENT_METHODS[:chmod], octet)
end

- (nil, OpenNebula::Error) chown(uid, gid)

Changes the owner/group

Parameters:

  • 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

Returns:



142
143
144
145
146
147
 
# File 'opennebula/document.rb', line 142

def chown(uid, gid)
    rc = check_type()
    return rc if OpenNebula.is_error?(rc)

    super(DOCUMENT_METHODS[:chown], uid, gid)
end

- (Integer, OpenNebula::Error) clone(name)

Clones this Document into a new one

Parameters:

  • name (String) —

    Name for the new Document.

Returns:

  • (Integer, OpenNebula::Error) —

    The new Document ID in case of success, Error otherwise



182
183
184
185
186
187
188
189
190
191
 
# File 'opennebula/document.rb', line 182

def clone(name)
    rc = check_type()
    return rc if OpenNebula.is_error?(rc)

    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(DOCUMENT_METHODS[:clone], @pe_id, name)

    return rc
end

- (nil, OpenNebula::Error) delete

Deletes the Document

Returns:



113
114
115
116
117
118
 
# File 'opennebula/document.rb', line 113

def delete()
    rc = check_type()
    return rc if OpenNebula.is_error?(rc)

    return call(DOCUMENT_METHODS[:delete], @pe_id)
end

- (Object) document_type 



229
230
231
 
# File 'opennebula/document.rb', line 229

def document_type
    self.class::DOCUMENT_TYPE
end

- (Integer) gid

Returns the group identifier

Returns:

  • (Integer) —

    the element's group ID



209
210
211
 
# File 'opennebula/document.rb', line 209

def gid
    self['GID'].to_i
end

- (nil, OpenNebula::Error) info Also known as: info!

Retrieves the information of the given Document.

Returns:



87
88
89
90
91
92
93
94
95
 
# File 'opennebula/document.rb', line 87

def info()
    rc = super(DOCUMENT_METHODS[:info], 'DOCUMENT')

    if !OpenNebula.is_error?(rc) && self['TYPE'].to_i != document_type
        return OpenNebula::Error.new("[DocumentInfo] Error getting document [#{@pe_id}].")
    end

    return rc
end

- (Integer) owner_id

Returns the owner user ID

Returns:

  • (Integer) —

    the element's owner user ID



215
216
217
 
# File 'opennebula/document.rb', line 215

def owner_id
    self['UID'].to_i
end

- (true, false) public?

Returns true if the GROUP_U permission bit is set

Returns:

  • (true, false) —

    true if the GROUP_U permission bit is set



221
222
223
224
225
226
227
 
# File 'opennebula/document.rb', line 221

def public?
    if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
        true
    else
        false
    end
end

- (nil, OpenNebula::Error) rename(name)

Renames this Document

Parameters:

  • name (String) —

    New name for the Document.

Returns:



199
200
201
 
# File 'opennebula/document.rb', line 199

def rename(name)
    return call(DOCUMENT_METHODS[:rename], @pe_id, name)
end

- (nil, OpenNebula::Error) update(new_template, append = false)

Replaces the template contents

Parameters:

  • new_template (String) —

    new template contents

  • append (true, false) (defaults to: false) —

    True to append new attributes instead of replace the whole template

Returns:



128
129
130
131
132
133
 
# File 'opennebula/document.rb', line 128

def update(new_template, append=false)
    rc = check_type()
    return rc if OpenNebula.is_error?(rc)

    super(DOCUMENT_METHODS[:update], new_template, append ? 1 : 0)
end