vas 0.4.0 → 1.0.0

data/lib/vas/shared/logs.rb

@@ -28,23 +28,41 @@ module Shared
 
   # abstract A log file in a node instance
   class Log < Shared::Resource
+    
+    include Deletable
 
     # @return [String] the name of the log
     attr_reader :name
 
-    # @return [NodeInstance] the node instance that the log belongs to
-    attr_reader :instance
+    # @return [Integer] the size of the log
+    attr_reader :size
+
+    # @return [Integer] the last modified stamp of the log
+    attr_reader :last_modified
     
     # @private
     def initialize(location, client, instance_type, instance_class)
       super(location, client)
 
-      @name = details['name']
       @content_location = Util::LinkUtils.get_link_href(details, 'content')
-      @instance = instance_class.new(Util::LinkUtils.get_link_href(details, instance_type), client)
+      @instance_location = Util::LinkUtils.get_link_href(details, instance_type)
+
+      @instance_class = instance_class
+    end
+
+    # Reloads the log's details from the server
+    #
+    # @return [void]
+    def reload
+      super
+      @name = details['name']
+      @size = details['size']
+      @last_modified = details['last-modified']
+      @instance = nil
     end
 
-    # Retrieve the content of the log
+
+    # Retrieves the content of the log from the server
     #
     # @param [Hash] options the options that control the content that is returned
     #
@@ -80,19 +98,14 @@ module Shared
       end
     end
 
-    # @return [Integer] the size of the log
-    def size
-      client.get(location)['size']
-    end
-
-    # @return [Integer] the last modified stamp of the log
-    def last_modified
-      client.get(location)['last-modified']
+    # @return [NodeInstance] the node instance that the log belongs to
+    def instance
+      @instance ||= @instance_class.new(@instance_location, client)
     end
 
     # @return [String] a string representation of the log
     def to_s
-      "#<#{self.class} name='#@name'>"
+      "#<#{self.class} name='#@name' size='#@size' last_modified='#@last_modified'>"
     end
   end
 end

data/lib/vas/shared/mutable_collection.rb

@@ -16,13 +16,21 @@
 
 module Shared
   
-  # @abstract A collection that allows items to be deleted from it
+  # @abstract A collection that allows items to be created
   class MutableCollection < Collection
 
-    # Deletes the item from the collection
-    # @return [void]
-    def delete(entry)
-      client.delete(entry.location)
+    # @private
+    def create(payload, rel=nil)
+      created = create_entry(client.post(location, payload, rel))
+      reload
+      created
+    end
+
+    # @private
+    def create_image(path, payload=nil)
+      created = create_entry(client.post_image(location, path, payload))
+      reload
+      created
     end
 
   end

data/lib/vas/shared/node_configuration.rb

@@ -0,0 +1,74 @@
+# vFabric Administration Server Ruby API
+# Copyright (c) 2012 VMware, Inc. All Rights Reserved.
+#
+# 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 Shared
+
+  # @abstract A configuration file in a node instance
+  class NodeConfiguration < Shared::Resource
+
+    # @return [String] the configuration's path
+    attr_reader :path
+
+    # @return [Integer] the configuration's size
+    attr_reader :size
+
+    # @private
+    def initialize(location, client, instance_type, instance_class, group_configuration_class)
+      super(location, client)
+
+      @instance_class = instance_class
+      @group_configuration_class = group_configuration_class
+
+      @instance_location = Util::LinkUtils.get_link_href(details, instance_type)
+      @group_configuration_location = Util::LinkUtils.get_link_href(details, 'group-live-configuration')
+      @content_location = Util::LinkUtils.get_link_href(details, 'content')
+
+      @path = details['path']
+    end
+
+    # Reloads the configuration's details from the server
+    # @return [void]
+    def reload
+      super
+      @size = details['size']
+    end
+
+    # Retrieves the configuration's content and passes it to the block
+    #
+    # @yield [chunk] a chunk of the configuration's content
+    #
+    # @return [void]
+    def content(&block)
+      client.get_stream(@content_location, &block)
+    end
+
+    # @return [LiveConfiguration] the node configuration's group configuration
+    def group_configuration
+      @group_configuration ||= @group_configuration_class.new(@group_configuration_location, client)
+    end
+
+    # @return [NodeInstance] the node instance that owns the configuration
+    def instance
+      @instance ||= @instance_class.new(@instance_location, client)
+    end
+
+    # @return [String] a string representation of the configuration
+    def to_s
+      "#<#{self.class} name='#@path' size=#@size>"
+    end
+
+  end
+end

data/lib/vas/shared/node_instances.rb

@@ -33,28 +33,46 @@ module Shared
     # @return [String] the instance's name
     attr_reader :name
 
-    # @return [GroupableNode] the node that contains this instance
-    attr_reader :node
+    # @private
+    def initialize(location, client, node_class, logs_class, group_instance_class, group_instance_type,
+        node_live_configurations_class)
+      super(location, client)
 
-    # @return [Logs] the instance's Logs
-    attr_reader :logs
+      @name = details['name']
 
-    # @return [Instance] the node instance's group instance
-    attr_reader :group_instance
+      @node_class = node_class
+      @logs_class = logs_class
+      @group_instance_class = group_instance_class
+      @live_configurations_class = node_live_configurations_class
 
-    # @private
-    def initialize(location, client, node_class, logs_class, group_instance_class, group_instance_type) #:nodoc:
-      super(location, client)
+      @node_location = Util::LinkUtils.get_link_href(details, 'node')
+      @logs_location = Util::LinkUtils.get_link_href(details, 'logs')
+      @group_instance_location = Util::LinkUtils.get_link_href(details, group_instance_type)
+      @live_configurations_location = Util::LinkUtils.get_link_href(details, 'node-live-configurations')
+    end
 
-      @name = details["name"]
+    # @return [GroupableNode] the node that contains this instance
+    def node
+      @node ||= @node_class.new(@node_location, client)
+    end
+
+    # @return [Logs] the instance's logs
+    def logs
+      @logs ||= @logs_class.new(@logs_location, client)
+    end
+
+    # @return [Instance] the node instance's group instance
+    def group_instance
+      @group_instance ||= @group_instance_class.new(@group_instance_location, client)
+    end
 
-      @node = node_class.new(Util::LinkUtils.get_link_href(details, "node"), client)
-      @logs = logs_class.new(Util::LinkUtils.get_link_href(details, "logs"), client)
-      @group_instance = group_instance_class.new(Util::LinkUtils.get_link_href(details, group_instance_type), client)
+    # @return the node instance's live configuration
+    def live_configurations
+      @live_configurations ||= @live_configurations_class.new(@live_configurations_location, client)
     end
 
     # @return [String] a string representation of the node instance
-    def to_s #:nodoc:
+    def to_s
       "#<#{self.class} name='#@name'>"
     end
 

data/lib/vas/shared/nodes.rb

@@ -30,23 +30,44 @@ module Shared
     
     # @return [String[]] the node's IP addresses
     attr_reader :ip_addresses
-    
-    # @return [Hash] the node's metadata
-    attr_reader :metadata
+
+    # @return [String[], nil] the node's IPv4 addresses. +nil+ if the server is not version 1.1.0 or later
+    attr_reader :ipv4_addresses
+
+    # @return [String[], nil] the node's IPv6 addresses. +nil+ if the server is not version 1.1.0 or later
+    attr_reader :ipv6_addresses
     
     # @return [String] the node's operating system
     attr_reader :operating_system
 
+    # @return [Hash] the node's metadata
+    attr_reader :metadata
+
     # @private
     def initialize(location, client)
       super(location, client)
-      
-      @agent_home = details["agent-home"]
-      @architecture = details["architecture"]
-      @host_names = details["host-names"]
-      @ip_addresses = details["ip-addresses"]
-      @metadata = details["metadata"]
-      @operating_system = details["operating-system"]
+    end
+
+    # Reloads the node's details from the server
+    #
+    # @return [void]
+    def reload
+      super
+      @agent_home = details['agent-home']
+      @architecture = details['architecture']
+      @host_names = details['host-names']
+      @ip_addresses = details['ip-addresses']
+      @ipv4_addresses = details['ipv4-addresses']
+      @ipv6_addresses = details['ipv6-addresses']
+      @metadata = details['metadata']
+      @operating_system = details['operating-system']
+    end
+
+    # Updates the node's metadata
+    # @return [void]
+    def update(metadata)
+      client.post(location, {:metadata => metadata})
+      reload
     end
 
   end
@@ -60,12 +81,14 @@ module Shared
       @group_class = group_class
     end
 
+    def reload
+      super
+      @groups = nil
+    end
+
     # @return [Group[]] the groups that contain this node
     def groups
-      groups = []
-      Util::LinkUtils.get_link_hrefs(client.get(location), 'group').each {
-          |group_location| groups << @group_class.new(group_location, client)}
-      groups
+      @groups ||= create_resources_from_links('group', @group_class)
     end
   end
 

data/lib/vas/shared/{pending_configuration.rb → pending_configurations.rb}

@@ -26,20 +26,22 @@ module Shared
     #
     # @return [PendingConfiguration] the new configuration
     def create(path, content)
-      entry_class.new(client.post_image(location, content, { :path => path }), client)
+      create_image(content, { :path => path })
     end
 
   end
 
   # @abstract A configuration file that is pending and will be made live the next time its instance is started
   class PendingConfiguration < Configuration
+    
+    include Deletable
 
     # Updates the contents of the configuration
     #
     # @param new_content [String] the new content
     def content=(new_content)
       client.post(content_location, new_content)
-      @size = client.get(location)['size']
+      reload
     end
 
   end

data/lib/vas/shared/resource.rb

@@ -37,10 +37,20 @@ module Shared
       @location = location
       @client = client
 
-      @details = client.get(location)
+      reload
 
-      @security = Security.new(Util::LinkUtils.get_link_href(@details, 'security'), client)
+      @security = Security.new(Util::LinkUtils.get_link_href(@details, 'security'), @client)
+    end
+
+    # Reloads the resource's details from the server
+    # @return [void]
+    def reload
+      @details = client.get(@location)
+    end
 
+    private
+    def create_resources_from_links(link_rel, resource_class)
+      Util::LinkUtils.get_link_hrefs(details, link_rel).collect {|location| resource_class.new(location, client)}
     end
   
   end

data/lib/vas/shared/security.rb

@@ -36,14 +36,21 @@ module Shared
   
     # @private
     def initialize(location, client)
-      json = client.get(location)
-      @location = location;
+      @location = location
+      @client = client
+
+      reload
+    end
+    
+    public
+
+    # Reloads the security configuration from server
+    def reload
+      json = @client.get(location)
       @owner = json["owner"]
       @group = json["group"]
       @permissions = json["permissions"]
     end
-    
-    public
 
     # @return [String] a string representation of this security object
     def to_s

data/lib/vas/shared/state_resource.rb

@@ -40,7 +40,7 @@ module Shared
       client.post(@state_location, { :status => 'STOPPED' })
     end
 
-    # @return [String] the state of the resource
+    # @return [String] Retrieves the state of the resource from the server
     def state
       client.get(@state_location)['status']
     end

data/lib/vas/sqlfire/agent_instances.rb

@@ -0,0 +1,98 @@
+# vFabric Administration Server Ruby API
+# Copyright (c) 2012 VMware, Inc. All Rights Reserved.
+#
+# 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 Sqlfire
+
+  # Used to enumerate, create, and delete agent instances.
+  class AgentInstances < Shared::MutableCollection
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'agent-group-instances', AgentInstance)
+    end
+
+    # Creates a new agent instance
+    #
+    # @param installation [Installation] the installation to be used by the instance
+    # @param name [String] the name of the instance
+    # @param options [Hash] optional configuration for the instance
+    #
+    # @option options 'jvm-options' [String[]] The JVM options that are passed to the agents's JVM when it is started
+
+    # @return [AgentInstance] the new agent instance
+    def create(installation, name, options = {})
+      payload = { :installation => installation.location, :name => name }
+
+      if options.has_key? 'jvm-options'
+        payload['jvm-options'] = options['jvm-options']
+      end
+
+      super(payload, 'agent-group-instance')
+    end
+
+  end
+
+  # An agent instance
+  class AgentInstance < Shared::Instance
+
+    # @return [String[]] The JVM options that are passed to the agent's JVM when it is started
+    attr_reader :jvm_options
+
+    # @private
+    def initialize(location, client)
+      super(location, client, Group, Installation, AgentLiveConfigurations, AgentPendingConfigurations, AgentNodeInstance, 'agent-node-instance')
+    end
+
+    # Reloads the agent instance's details from the server
+    # @return [void]
+    def reload
+      super
+      @jvm_options = details['jvm-options']
+    end
+
+    # Updates the instance using the supplied +options+
+    #
+    # @param options [Hash] optional configuration for the instance
+    #
+    # @option options :installation [String] The installation to be used by the instance. If omitted or +nil+, the
+    #   configuration will not be changed.
+    # @option options 'jvm-options' [String[]] The JVM options that are passed to the agent's JVM when it is started.
+    #   If omitted or +nil+, the configuration will not be changed
+    #
+    # @return [void]
+    def update(options = {})
+      payload = {}
+
+      if options.has_key? 'jvm-options'
+        payload['jvm-options'] = options['jvm-options']
+      end
+
+      if options.has_key? :installation
+        payload[:installation] = options[:installation].location
+      end
+
+      client.post(location, payload)
+      reload
+    end
+
+    # @return [String] a string representation of the instance
+    def to_s
+      "#<#{self.class} name='#{name}' jvm_options='#@jvm_options'>"
+    end
+
+  end
+
+end