vas 0.4.0 → 1.0.0

data/lib/vas/sqlfire/server_live_configurations.rb

@@ -0,0 +1,39 @@
+# 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 a server instance's live configuration
+  class ServerLiveConfigurations < Shared::Collection
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'live-configurations', ServerLiveConfiguration)
+    end
+
+  end
+  
+  # A live configuration file in a server instance
+  class ServerLiveConfiguration < Shared::LiveConfiguration
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'server-group-instance', ServerInstance, ServerNodeLiveConfiguration)
+    end
+
+  end
+
+end

data/lib/vas/sqlfire/server_logs.rb

@@ -0,0 +1,39 @@
+# 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 a server node instance's logs
+  class ServerLogs < Shared::Logs
+
+    # @private
+    def initialize(location, client)
+      super(location, client, ServerLog)
+    end
+
+  end
+
+  # A log file in a server node instance
+  class ServerLog < Shared::Log
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'server-node-instance', ServerNodeInstance)
+    end
+
+  end
+
+end

data/lib/vas/sqlfire/server_node_instances.rb

@@ -0,0 +1,86 @@
+# 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 server instances on an individual node
+  class ServerNodeInstances < Shared::NodeInstances
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'server-node-instances', ServerNodeInstance)
+    end
+
+  end
+
+  # A server node instance
+  class ServerNodeInstance < Shared::NodeInstance
+
+    # @return [String] the property in a node's metadata used to determine the address that the server binds to for
+    #   peer-to-peer communication. If +nil+, the server uses the node's hostname
+    attr_reader :bind_address
+
+    # @return [String] the property in a node's metadata used to determine the address that the server binds to for
+    #   client communication. If +nil+, the server uses localhost. Only takes effect if +run_netserver+ is +true+
+    attr_reader :client_bind_address
+
+    # @return [Integer] the port that the server listens on for client connections. Only takes effect if +run_netserver+
+    #   is +true+
+    attr_reader :client_port
+
+    # @return [Integer] critical heap percentage as a percentage of the old generation heap. +nil+ if the server uses
+    #   the default
+    attr_reader :critical_heap_percentage
+
+    # @return [String] The initial heap size of the server's JVM. +nil+ if the default is used
+    attr_reader :initial_heap
+
+    # @return [String[]] The JVM options that are passed to the server's JVM when it is started
+    attr_reader :jvm_options
+
+    # @return [String] The max heap size of the server's JVM. +nil+ if the default is used
+    attr_reader :max_heap
+
+    # @return [Boolean] +true+ if the server runs a netserver that can service thin clients, otherwise +false+
+    attr_reader :run_netserver
+
+    # @private
+    def initialize(location, client)
+      super(location, client, Node, ServerLogs, ServerInstance, 'server-group-instance', ServerNodeLiveConfigurations)
+    end
+
+    # Reloads the instance's details from the server
+    # @return [void]
+    def reload
+      super
+      @bind_address = details['bind-address']
+      @client_bind_address = details['client-bind-address']
+      @client_port = details['client-port']
+      @critical_heap_percentage = details['critical-heap-percentage']
+      @initial_heap = details['initial-heap']
+      @jvm_options = details['jvm-options']
+      @max_heap = details['max-heap']
+      @run_netserver = details['run-netserver']
+    end
+
+    # @return [String] a string representation of the instance
+    def to_s
+      "#<#{self.class} name='#{name}' bind_address='#@bind_address' client_bind_address='#@client_bind_address' client_port='#@client_port' critical_heap_percentage='#@critical_heap_percentage' initial_heap='#@initial_heap' jvm_options='#@jvm_options' max_heap='#@max_heap' run_netserver='#@run_netserver'>"
+    end
+
+  end
+
+end

data/lib/vas/sqlfire/server_node_live_configurations.rb

@@ -0,0 +1,39 @@
+# 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 a server node instance's live configuration
+  class ServerNodeLiveConfigurations < Shared::Collection
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'node-live-configurations', ServerNodeLiveConfiguration)
+    end
+
+  end
+  
+  # A live configuration file in a server node instance
+  class ServerNodeLiveConfiguration < Shared::NodeConfiguration
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'server-node-instance', ServerNodeInstance, ServerLiveConfiguration)
+    end
+
+  end
+
+end

data/lib/vas/sqlfire/server_pending_configurations.rb

@@ -0,0 +1,39 @@
+# 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 a server instance's pending configuration
+  class ServerPendingConfigurations < Shared::PendingConfigurations
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'pending-configurations', ServerPendingConfiguration)
+    end
+
+  end
+
+  # A server configuration file that is pending
+  class ServerPendingConfiguration < Shared::PendingConfiguration
+
+    # @private
+    def initialize(location, client)
+      super(location, client, 'server-group-instance', ServerInstance)
+    end
+
+  end
+
+end

data/lib/vas/sqlfire/sqlfire.rb

@@ -0,0 +1,44 @@
+# 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.
+
+
+# API for administering SQLFire
+module Sqlfire
+  
+  # The entry point to the API for administering SQLFire
+  class Sqlfire
+
+    # @return [Groups] the SQLFire groups
+    attr_reader :groups
+
+    # @return [InstallationImages] the SQLFire installation images
+    attr_reader :installation_images
+
+    # @return [Nodes] the SQLFire nodes
+    attr_reader :nodes
+    
+    # @private
+    def initialize(location, client)
+
+      json = client.get(location)
+      
+      @groups = Groups.new(Util::LinkUtils.get_link_href(json, 'groups'), client)
+      @installation_images = InstallationImages.new(Util::LinkUtils.get_link_href(json, 'installation-images'), client)
+      @nodes = Nodes.new(Util::LinkUtils.get_link_href(json, 'nodes'), client)
+
+    end
+    
+  end
+end

data/lib/vas/tc_server/applications.rb

@@ -32,18 +32,20 @@ module TcServer
     #
     # @return [Application] the new application
     def create(name, context_path, service, host)
-      Application.new(client.post(location, {"context-path" => context_path, :name => name, :host => host, :service => service}, "group-application"), client)
+      payload = {'context-path' => context_path,
+                 :name => name,
+                 :host => host,
+                 :service => service}
+      super(payload, 'group-application')
     end
 
-    private
-    def create_entry(json)
-      Application.new(Util::LinkUtils.get_self_link_href(json), client)
-    end
   end
 
   # An application
   class Application < Shared::Resource
 
+    include Shared::Deletable
+
     # @return [String] the application's context path
     attr_reader :context_path
 
@@ -56,30 +58,39 @@ module TcServer
     # @return [String] the host the application will deploy its revisions to
     attr_reader :host
 
-    # @return [Revisions] the application's revisions
-    attr_reader :revisions
-    
-    # @return [Instance] the instance that contains the application
-    attr_reader :instance
-
     # @private
     def initialize(location, client)
       super(location, client)
 
-      @revisions = Revisions.new(Util::LinkUtils.get_link_href(details, "group-revisions"), client)
-      @context_path = details["context-path"]
-      @name = details["name"]
-      @service = details["service"]
-      @host = details["host"]
-      @instance = Instance.new(Util::LinkUtils.get_link_href(details, "group-instance"), client)
+      @revisions_location = Util::LinkUtils.get_link_href(details, 'group-revisions')
+      @instance_location = Util::LinkUtils.get_link_href(details, 'group-instance')
+
+      @context_path = details['context-path']
+      @name = details['name']
+      @service = details['service']
+      @host = details['host']
+    end
+
+    # Reloads the application's details from the server
+    # @return [void]
+    def reload
+      super
+      @node_applications = nil
     end
 
     # @return [NodeApplication[]] the application's individual node applications
     def node_applications
-      node_applications = []
-      Util::LinkUtils.get_link_hrefs(client.get(location), 'node-application').each {
-          |node_application_location| node_applications << NodeApplication.new(node_application_location, client)}
-      node_applications
+      @node_applications ||= create_resources_from_links('node-application', NodeApplication)
+    end
+
+    # @return [Instance] the instance that contains the application
+    def instance
+      @instance ||= Instance.new(@instance_location, client)
+    end
+
+    # @return [Revisions] the application's revisions
+    def revisions
+      @revisions ||= Revisions.new(@revisions_location, client)
     end
 
     # @return [String] a string representation of the application

data/lib/vas/tc_server/configuration.rb

@@ -21,7 +21,7 @@ module TcServer
 
     # @private
     def initialize(location, client)
-      super(location, client, "group-instance", Instance)
+      super(location, client, 'group-instance', Instance)
     end
 
   end

data/lib/vas/tc_server/groups.rb

@@ -29,13 +29,16 @@ module TcServer
   # A tc Server group
   class Group < Shared::MutableGroup
 
-    # The group's instances
-    attr_reader :instances
-    
     # @private
     def initialize(location, client)
       super(location, client, Node, Installations)
-      @instances = Instances.new(Util::LinkUtils.get_link_href(details, "group-instances"), client)
+
+      @instances_location = Util::LinkUtils.get_link_href(details, 'group-instances')
+    end
+
+    # @return [Instances] the group's instances
+    def instances
+      @instances ||= Instances.new(@instances_location, client)
     end
 
   end

data/lib/vas/tc_server/installations.rb

@@ -31,21 +31,31 @@ module TcServer
 
     # @return [String[]] the versions of the tc Server runtime that are supported by the installation
     attr_reader :runtime_versions
-    
-    # @return [Templates] the installation's templates
-    attr_reader :templates
 
     # @private
     def initialize(location, client)
       super(location, client, InstallationImage, Group)
 
-      @runtime_versions = details["runtime-versions"]
-      @templates = Templates.new(Util::LinkUtils.get_link_href(details, "templates"), client)
+      @runtime_versions = details['runtime-versions']
+      @templates_location = Util::LinkUtils.get_link_href(details, 'templates')
+    end
+
+    # Reloads the installation's details from the server
+    #
+    # @return [void]
+    def reload
+      super
+      @instances = nil
     end
 
     # @return [Instance[]] the instances that are using the installation
     def instances
-      retrieve_instances("group-instance", Instance);
+      @instances ||= create_resources_from_links('group-instance', Instance)
+    end
+
+    # @return [Templates] the installation's templates
+    def templates
+      @templates ||= Templates.new(@templates_location, client)
     end
     
   end