occi 1.2.1 → 2.0.0

data/lib/occi/extensions/monitoring/netrx.rb

@@ -0,0 +1,49 @@
+##############################################################################
+#  Copyright 2012 GWDG
+#  
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OCCI monitoring VM Network reception
+# Author(s): Ali Imran Jehangiri, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'singleton'
+require 'occi/core/mixin'
+
+module OCCI
+  module Monitor
+    class Nettx < OCCI::Core::Mixin
+
+      # Define appropriate mixin
+      begin
+        # Define actions
+        actions = []
+
+        related = [OCCI::Monitor::Metric::MIXIN]
+        entities = []
+
+        term    = "net_rx"
+        scheme  = "http://example.com/occi/infrastructure/metric/compute#"
+        title   = "compute.net_rx"
+        
+        attributes = OCCI::Core::Attributes.new()
+        MIXIN = OCCI::Core::Mixin.new(term, scheme, title, attributes, actions, related, entities)
+        OCCI::CategoryRegistry.register(MIXIN)
+        OCCI::Rendering::HTTP::LocationRegistry.register('/metric/compute/net_rx', MIXIN)
+
+      end
+    end
+  end
+end

data/lib/occi/extensions/monitoring/nettx.rb

@@ -0,0 +1,55 @@
+##############################################################################
+#  Copyright 2012 GWDG
+#  
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OCCI monitoring VM Network transmission
+# Author(s): Ali Imran Jehangiri, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'singleton'
+require 'occi/core/mixin'
+
+module OCCI
+  module Monitor
+    class Nettx < OCCI::Core::Mixin
+
+      # Define appropriate mixin
+      begin
+        # Define actions
+        actions = []
+
+        related = [OCCI::Monitor::Metric::MIXIN]
+        entities = []
+
+        term    = "net_tx"
+        scheme  = "http://example.com/occi/infrastructure/metric/compute#"
+        title   = "compute.net_tx"
+        
+        attributes = OCCI::Core::Attributes.new()
+      #  attributes << OCCI::Core::Attribute.new(name = 'compute.net_tx.value',        mutable = false,   mandatory = true,  unique = true)
+      #  attributes << OCCI::Core::Attribute.new(name = 'compute.net_tx.timestamp', mutable = false,   mandatory = true,  unique = true)
+      #  attributes << OCCI::Core::Attribute.new(name = 'compute.net_tx.samplerate',        mutable = true,  mandatory = false,   unique = true)
+      #  attributes << OCCI::Core::Attribute.new(name = 'compute.net_tx.resolution',     mutable = true,   mandatory = false,  unique = true)
+      #  attributes << OCCI::Core::Attribute.new(name = 'compute.net_tx.unit',       mutable = false,   mandatory = true,  unique = true)
+        MIXIN = OCCI::Core::Mixin.new(term, scheme, title, attributes, actions, related, entities)
+        
+        OCCI::CategoryRegistry.register(MIXIN)
+        OCCI::Rendering::HTTP::LocationRegistry.register('/metric/compute/net_tx', MIXIN)
+
+      end
+    end
+  end
+end

data/lib/occi/extensions/one/VNC.rb

@@ -0,0 +1,58 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OCCI Mixin to support OpenNebula specific virtual machine parameters
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'occi/core/mixin'
+require 'occi/core/attribute'
+require 'occi/core/attributes'
+require 'singleton'
+
+module OCCI
+  module Backend
+    module ONE
+      class VNC < OCCI::Core::Mixin
+
+        # Define appropriate mixin
+        begin
+          # Define actions
+          actions = []
+
+          related = []
+          entities = []
+
+          term    = "vnc"
+          scheme  = "http://schemas.opennebula.org/occi/infrastructure#"
+          title   = "OpenNebula VNC Mixin"
+
+          attributes = OCCI::Core::Attributes.new()
+          attributes << OCCI::Core::Attribute.new(name = 'opennebula.vm.vnc',     mutable = true, required = false,  type = "string", range = "", default = "")
+          attributes << OCCI::Core::Attribute.new(name = 'opennebula.vm.web_vnc', mutable = true, required = false,  type = "string", range = "", default = "")
+      
+          MIXIN = OCCI::Core::Mixin.new(term, scheme, title, attributes, actions, related, entities)
+        end
+
+        def initialize(term, scheme, title, attributes, actions, related, entities)
+          super(term, scheme, title, attributes, actions, related, entities)
+        end
+        
+      end
+    end
+  end
+end

data/lib/occi/extensions/one/vnc.rb

@@ -0,0 +1,58 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OCCI Mixin to support OpenNebula specific virtual machine parameters
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'occi/core/mixin'
+require 'occi/core/attribute'
+require 'occi/core/attributes'
+require 'singleton'
+
+module OCCI
+  module Backend
+    module ONE
+      class VNC < OCCI::Core::Mixin
+
+        # Define appropriate mixin
+        begin
+          # Define actions
+          actions = []
+
+          related = []
+          entities = []
+
+          term    = "vnc"
+          scheme  = "http://schemas.opennebula.org/occi/infrastructure#"
+          title   = "OpenNebula VNC Mixin"
+
+          attributes = OCCI::Core::Attributes.new()
+          attributes << OCCI::Core::Attribute.new(name = 'opennebula.vm.vnc',     mutable = true, required = false,  type = "string", range = "", default = "")
+          attributes << OCCI::Core::Attribute.new(name = 'opennebula.vm.web_vnc', mutable = true, required = false,  type = "string", range = "", default = "")
+      
+          MIXIN = OCCI::Core::Mixin.new(term, scheme, title, attributes, actions, related, entities)
+        end
+
+        def initialize(term, scheme, title, attributes, actions, related, entities)
+          super(term, scheme, title, attributes, actions, related, entities)
+        end
+        
+      end
+    end
+  end
+end

data/lib/occi/log.rb

@@ -0,0 +1,47 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OCCI logger
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'logger'
+
+module OCCI
+  class Log
+
+    def self.debug(message)
+      ActiveSupport::Notifications.instrument("log",:level=>Logger::DEBUG,:message=>message)
+    end
+
+    def self.info(message)
+      ActiveSupport::Notifications.instrument("log", :level => Logger::INFO, :message => message)
+    end
+
+    def self.warn(message)
+      ActiveSupport::Notifications.instrument("log", :level => Logger::WARN, :message => message)
+    end
+
+    def self.error(message)
+      ActiveSupport::Notifications.instrument("log", :level => Logger::ERROR, :message => message)
+    end
+
+    def self.fatal(message)
+      ActiveSupport::Notifications.instrument("log", :level => Logger::FATAL, :message => message)
+    end
+  end
+end

data/lib/occi/parse.rb

@@ -0,0 +1,164 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# @note OCCI RESTful Web Service
+# @author Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'json'
+#require 'nokogiri'
+require 'occi/core/collection'
+require 'occi/log'
+require 'occi/antlr/OCCIParser'
+
+module OCCI
+  class Parse
+
+=begin
+          if content_type.includes?('multipart')
+            # TODO: implement multipart handling
+            # handle file upload
+            if params['file'] != nil
+              OCCI::Log.debug("Location of Image #{params['file'][:tempfile].path}")
+              $image_path = OCCI::Server.config[:one_image_tmp_dir] + '/' + params['file'][:filename]
+              FileUtils.cp(params['file'][:tempfile].path, $image_path)
+            end
+
+            # handle file upload in multipart requests
+            request.POST.values.each do |body|
+              if body.kind_of?(String)
+                parse_text(body)
+              elsif body.kind_of?(Hash)
+                if body['type'].include?('application/json')
+                  # try to parse body as JSON object
+                  parse_json(body.read)
+                elsif body['type'].include?('text/plain') # text/plain
+                  parse_text(body.read)
+                end unless body['type'].nil?
+              end
+            end
+          end
+=end
+
+    def self.header_locations(header)
+      x_occi_location_strings = header['HTTP_X_OCCI_LOCATION'].to_s.split(',')
+      x_occi_location_strings.collect { |loc| OCCI::Parser.new('X-OCCI-Location: ' + loc).x_occi_location }
+    end
+
+    def self.header_categories(header)
+      collection = OCCI::Core::Collection.new
+      category_strings = header['HTTP_CATEGORY'].to_s.split(',')
+      category_strings.each do |cat|
+        category = OCCI::Parser.new('Category: ' + cat).category
+        collection.kinds.concat category.kinds.collect { |kind| OCCI::Core::Kind.new(kind) }
+        collection.mixins.concat category.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) }
+        collection.actions.concat category.actions.collect { |action| OCCI::Core::Action.new(action) }
+      end
+      collection
+    end
+
+    def self.header_entity(header)
+      collection = OCCI::Core::Collection.new
+      entity = Hashie::Mash.new
+      category_strings = header['HTTP_CATEGORY'].to_s.split(',')
+      return collection if category_strings.empty?
+      attribute_strings = header['HTTP_X_OCCI_ATTRIBUTE'].to_s.split(',')
+      categories = Hashie::Mash.new({:kinds => [], :mixins => [], :actions => []})
+      category_strings.each { |cat| categories.merge!(OCCI::Parser.new('Category: ' + cat).category) }
+      return collection if categories.kinds.empty?
+      entity.kind = categories.kinds.first.scheme + categories.kinds.first.term
+      entity.mixins = categories.mixins.collect { |mixin| mixin.scheme + mixin.term } if categories.mixins.any?
+      attribute_strings.each { |attr| entity.attributes!.merge!(OCCI::Parser.new('X-OCCI-Attribute: ' + attr).x_occi_attribute) }
+      kind = OCCI::Registry.get_by_id(entity.kind)
+      # TODO: error handling
+      return collection if kind.nil?
+      if kind.entity_type == OCCI::Core::Link.name
+        entity.target = link.attributes.occi!.core!.target
+        entity.source = link.attributes.occi!.core!.source
+        collection.links << OCCI::Core::Link.new(entity)
+      elsif kind.entity_type == OCCI::Core::Resource.name
+        link_strings = header['HTTP_LINK'].to_s.split(',')
+        link_strings.each { |link| entity.links << OCCI::Parser.new('Link: ' + link).link }
+        collection.resources << OCCI::Core::Resource.new(entity)
+      end
+      collection
+    end
+
+    def self.text_locations(text)
+      text.lines.collect { |line| OCCI::Parser.new(line).x_occi_location if line.include? 'X-OCCI-Location' }.compact
+    end
+
+    def self.text_categories(text)
+      collection = OCCI::Core::Collection.new
+      text.each_line do |line|
+        category = OCCI::Parser.new(line).category
+        collection.kinds.concat category.kinds.collect { |kind| OCCI::Core::Kind.new(kind) }
+        collection.mixins.concat category.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) }
+        collection.actions.concat category.actions.collect { |action| OCCI::Core::Action.new(action) }
+      end
+      collection
+    end
+
+    def self.text_entity(text)
+      collection = OCCI::Core::Collection.new
+      entity = Hashie::Mash.new
+      links = []
+      categories = Hashie::Mash.new({:kinds => [], :mixins => [], :actions => []})
+      text.each_line do |line|
+        categories.merge!(OCCI::Parser.new(line).category) if line.include? 'Category'
+        entity.attributes!.merge!(OCCI::Parser.new(line).x_occi_attribute) if line.include? 'X-OCCI-Attribute'
+        links << OCCI::Parser.new(line).link if line.include? 'Link'
+      end
+      entity.kind = categories.kinds.first.scheme + categories.kinds.first.term if categories.kinds.first
+      entity.mixins = categories.mixins.collect { |mixin| mixin.scheme + mixin.term } if entity.mixins
+      kind = OCCI::Registry.get_by_id(entity.kind)
+      # TODO: error handling
+      return collection if kind.nil?
+      if OCCI::Registry.get_by_id(entity.kind).entity_type == OCCI::Core::Link.name
+        entity.target = links.first.attributes.occi!.core!.target
+        entity.source = links.first.attributes.occi!.core!.source
+        collection.links << OCCI::Core::Link.new(entity)
+      elsif OCCI::Registry.get_by_id(entity.kind).entity_type == OCCI::Core::Resource.name
+        entity.links = links
+        collection.resources << OCCI::Core::Resource.new(entity)
+      end unless entity.kind.nil?
+      collection
+    end
+
+    def self.json(json)
+      collection = OCCI::Core::Collection.new
+      hash = Hashie::Mash.new(JSON.parse(json))
+      collection.kinds.concat hash.kinds.collect { |kind| OCCI::Core::Kind.new(kind) } if hash.kinds
+      collection.mixins.concat hash.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) } if hash.mixins
+      collection.resources.concat hash.resources.collect { |resource| OCCI::Core::Resource.new(resource) } if hash.resources
+      collection.links.concat hash.links.collect { |link| OCCI::Core::Link.new(link) } if hash.links
+      collection
+    end
+
+    #def self.xml(xml)
+    #  collection = OCCI::Core::Collection.new
+    #  hash = Hashie::Mash.new(Hash.from_xml(Nokogiri::XML(xml)))
+    #  collection.kinds.concat hash.kinds.collect { |kind| OCCI::Core::Kind.new(kind) } if hash.kinds
+    #  collection.mixins.concat hash.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) } if hash.mixins
+    #  collection.resources.concat hash.resources.collect { |resource| OCCI::Core::Resource.new(resource) } if hash.resources
+    #  collection.links.concat hash.links.collect { |link| OCCI::Core::Link.new(link) } if hash.links
+    # collection
+    #end
+
+  end
+
+end

data/lib/occi/registry.rb

@@ -0,0 +1,87 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: registry for all Category/Kind/Mixin instances currently
+#              known to the OCCI server
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'occi/log'
+
+module OCCI
+  # ---------------------------------------------------------------------------------------------------------------------
+  module Registry
+
+    @@categories = {}
+    @@locations = {}
+
+    def self.reset()
+      @@categories.each_value.each {|category| category.entities = [] if category.entities}
+    end
+
+    # ---------------------------------------------------------------------------------------------------------------------
+    def self.register(category)
+      OCCI::Log.debug("### Registering category #{category.type_identifier}")
+      @@categories[category.type_identifier] = category
+      @@locations[category.location] = category.type_identifier unless category.kind_of?(OCCI::Core::Action)
+    end
+
+    # ---------------------------------------------------------------------------------------------------------------------
+    def self.unregister(category)
+      OCCI::Log.debug("### Unregistering category #{category.type_identifier}")
+      @@categories.delete(category.type_identifier)
+      @@locations.delete(category.location) unless category.kind_of?(OCCI :Core::Action)
+    end
+
+    # Returns the category corresponding to a given type identifier
+    #
+    # @param [URI] type identifier of a category
+    def self.get_by_id(id)
+      @@categories.fetch(id) { OCCI::Log.debug("Category with id #{id} not found"); nil }
+    end
+
+    # Returns the category corresponding to a given location
+    #
+    # @param [URI] Location of a category
+    def self.get_by_location(location)
+      id = @@locations.fetch(location) { OCCI::Log.debug("Category with location #{location} not found"); nil }
+      self.get_by_id(id)
+    end
+
+    # Return all categories from category registry. If filter is present, return only the categories specified by filter
+    #
+    # @param [Hashie:Hash] filter
+    # @return [Hashie::Mash] collection
+    def self.get(filter = [])
+      collection = Hashie::Mash.new({:kinds => [], :mixins => [], :actions => []})
+      filter.each do |cat|
+        category = get_by_id(cat.type_identifier)
+        collection.kinds << category if category.kind_of?(OCCI::Core::Kind)
+        collection.mixins << category if category.kind_of?(OCCI::Core::Mixin)
+        collection.actions << category if category.kind_of?(OCCI::Core::Action)
+      end
+      if filter.empty?
+        @@categories.each_value do |category|
+          collection.kinds << category if category.kind_of? OCCI::Core::Kind
+          collection.mixins << category if category.kind_of? OCCI::Core::Mixin
+          collection.actions << category if category.kind_of? OCCI::Core::Action
+        end
+      end
+      return collection
+    end
+  end
+end