vas 0.3.0 → 0.4.0

data/lib/vas/gemfire/cache_server_live_configurations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,15 +12,26 @@
 # 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 Gemfire
 
   # Used to enumerate a cache server instance's live configuration
   class CacheServerLiveConfigurations < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
-      super(location, client, "live-configurations", CacheServerConfiguration)
+    # @private
+    def initialize(location, client)
+      super(location, client, "live-configurations", CacheServerLiveConfiguration)
+    end
+
+  end
+  
+  # A live configuration file in a cache server instance
+  class CacheServerLiveConfiguration < Shared::Configuration
+
+    # @private
+    def initialize(location, client)
+      super(location, client, "cache-server-group-instance", CacheServerInstance)
     end
 
   end

data/lib/vas/gemfire/cache_server_logs.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,14 +12,15 @@
 # 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 Gemfire
 
   # Used to enumerate a cache server node instance's logs
   class CacheServerLogs < Shared::Logs
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, CacheServerLog)
     end
 
@@ -29,7 +29,8 @@ module Gemfire
   # A log file in a cache server node instance
   class CacheServerLog < Shared::Log
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'cache-server-node-instance', CacheServerNodeInstance)
     end
 

data/lib/vas/gemfire/cache_server_node_instances.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,14 +12,15 @@
 # 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 Gemfire
 
   # Used to enumerate cache server instances on an individual node
   class CacheServerNodeInstances < Shared::NodeInstances
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "cache-server-node-instances", CacheServerNodeInstance)
     end
 
@@ -29,13 +29,14 @@ module Gemfire
   # A cache server node instance
   class CacheServerNodeInstance < Shared::NodeInstance
 
-    # The instance's disk stores
+    # @return [DiskStores] the instance's disk stores
     attr_reader :disk_stores
 
-    # The instance's statistics
+    # @return [Statistics] the instance's statistics
     attr_reader :statistics
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Node, CacheServerLogs, CacheServerInstance, 'cache-server-group-instance')
       @disk_stores = DiskStores.new(Util::LinkUtils.get_link_href(details, 'disk-stores'), client)
       @statistics = Statistics.new(Util::LinkUtils.get_link_href(details, 'statistics'), client)

data/lib/vas/gemfire/cache_server_pending_configurations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,23 +12,25 @@
 # 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 Gemfire
 
   # Used to enumerate a cache server instance's pending configuration
   class CacheServerPendingConfigurations < Shared::PendingConfigurations
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'pending-configurations', CacheServerPendingConfiguration)
     end
 
   end
 
-  # A configuration file that is pending
+  # A cache server configuration file that is pending
   class CacheServerPendingConfiguration < Shared::PendingConfiguration
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, 'cache-server-group-instance', CacheServerInstance)
     end
 

data/lib/vas/gemfire/disk_stores.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,47 +12,58 @@
 # 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 Gemfire
 
+  # Provides access to a cache server node instance's disk stores
   class DiskStores < Shared::MutableCollection
 
+    # @private
     def initialize(location, client)
       super(location, client, 'disk-stores', DiskStore)
     end
 
   end
 
+  # A disk store in a cache server node instance
   class DiskStore < Shared::Resource
 
-    # The last modified time of the disk store
-    attr_reader :last_modified
-
-    # The name of the disk store
+    # @return [String] the name of the disk store
     attr_reader :name
 
-    # The size of the disk store
-    attr_reader :size
-
-    # The disk store's cache server node instance
+    # @return [CacheServerNodeInstance] the disk store's cache server node instance
     attr_reader :instance
 
+    # @private
     def initialize(location, client)
       super(location, client)
 
-      @last_modified = details['last-modified']
       @name = details['name']
-      @size = details['size']
       @instance = CacheServerNodeInstance.new(Util::LinkUtils.get_link_href(details, 'cache-server-node-instance'), client)
       @content_location = Util::LinkUtils.get_link_href(details, 'content')
     end
 
-    # Retrieves the disk store's content and passes it to the +block+
+    # Retrieves the disk store's content
+    #
+    # @yield [chunk] a chunk of the disk store's content
+    #
+    # @return [void]
     def content(&block)
       client.get_stream(@content_location, &block)
     end
+    
+    # @return [Integer] the size of the disk store
+    def size
+      client.get(location)['size']
+    end
+
+    # @return [Integer] the last modified stamp of the disk store
+    def last_modified
+      client.get(location)['last-modified']
+    end
 
+    # @return [String] a string representation of the disk store
     def to_s
       "#<#{self.class} name='#@name'>"
     end

data/lib/vas/gemfire/gemfire.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,26 +12,28 @@
 # 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 GemFire
 module Gemfire
   
   # The entry point to the API for administering GemFire
   class Gemfire
 
-    # The GemFire groups
+    # @return [Groups] the GemFire groups
     attr_reader :groups
 
-    # The GemFire installation images
+    # @return [InstallationImages] the GemFire installation images
     attr_reader :installation_images
 
-    # The GemFire nodes
+    # @return [Nodes] the GemFire nodes
     attr_reader :nodes
 
-    # The GemFire application code images
+    # @return [ApplicationCodeImages] the GemFire application code images
     attr_reader :application_code_images
     
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
 
       json = client.get(location)
       

data/lib/vas/gemfire/groups.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,32 +12,34 @@
 # 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 Gemfire
 
   # Used to enumerate, create, and delete GemFire groups.
   class Groups < Shared::Groups
 
-    def initialize(location, client) #:nodoc:#
+    # @private
+    def initialize(location, client)
       super(location, client, Group)
     end
 
   end
 
-  # A tc Server group
+  # A GemFire group
   class Group < Shared::MutableGroup
 
-    # The group's agent instances
+    # @return [AgentInstances] the group's agent instances
     attr_reader :agent_instances
 
-    # The group's cache server instances
+    # @return [CacheServerInstances] the group's cache server instances
     attr_reader :cache_server_instances
 
-    # The group's locator instances
+    # @return [LocatorInstances] the group's locator instances
     attr_reader :locator_instances
 
-    def initialize(location, client) #:nodoc:#
+    # @private
+    def initialize(location, client)
       super(location, client, Node, Installations)
       @agent_instances = AgentInstances.new(Util::LinkUtils.get_link_href(details, "agent-group-instances"), client)
       @cache_server_instances = CacheServerInstances.new(Util::LinkUtils.get_link_href(details, "cache-server-group-instances"), client)

data/lib/vas/gemfire/installation_images.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,14 +12,15 @@
 # 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 Gemfire
 
   # Used to enumerate, create, and delete GemFire installation images.
   class InstallationImages < Shared::InstallationImages
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, InstallationImage)
     end
 
@@ -29,7 +29,8 @@ module Gemfire
   # A GemFire installation image
   class InstallationImage < Shared::InstallationImage
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Installation)
     end
 

data/lib/vas/gemfire/installations.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,37 +12,39 @@
 # 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 Gemfire
 
   # Used to enumerate, create, and delete GemFire installations.
   class Installations < Shared::Installations
-    
-    def initialize(location, client) #:nodoc:
+
+    # @private
+    def initialize(location, client)
       super(location, client, Installation)
     end
-    
+
   end
-  
+
   # A GemFire installation
   class Installation < Shared::Installation
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, InstallationImage, Group)
     end
 
-    # An array of the agent instances that are using the installation
+    # @return [AgentInstance[]] the agent instances that are using the installation
     def agent_instances
       retrieve_instances("agent-group-instance", AgentInstance);
     end
 
-    # An array of the agent instances that are using the installation
+    # @return [CacheServerInstance[]] the cache server instances that are using the installation
     def cache_server_instances
       retrieve_instances("cache-server-group-instance", CacheServerInstance);
     end
 
-    # An array of the locator instances that are using the installation
+    # @return [LocatorInstance[]] the locator instances that are using the installation
     def locator_instances
       retrieve_instances("locator-group-instance", LocatorInstance);
     end

data/lib/vas/gemfire/live_application_codes.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,14 +12,15 @@
 # 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 Gemfire
 
   # Used to enumerate a cache server's live application code.
   class LiveApplicationCodes < Shared::Collection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "live-application-code", ApplicationCode)
     end
 

data/lib/vas/gemfire/locator_instances.rb

@@ -1,4 +1,3 @@
-#--
 # vFabric Administration Server Ruby API
 # Copyright (c) 2012 VMware, Inc. All Rights Reserved.
 #
@@ -13,25 +12,26 @@
 # 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 Gemfire
 
   # Used to enumerate, create, and delete locator instances.
   class LocatorInstances < Shared::MutableCollection
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, "locator-group-instances", LocatorInstance)
     end
 
-    # Creates a new instance named +name+, using the given +installation+.
-    # Creation can be customized using +options+.
-    #
-    # Recognized options are:
-    #
-    # peer::   +true+ if the locator should act as a peer, otherwise +false+. Defaults to +true+
-    # port::   The port on which the locator should listen. If omitted the locator will listen on the default port (10334)
-    # server:: +true+ if the locator should act as a server, otherwise +false+. Defaults to +true+
+    # Creates a new locator instance
+    # @param installation [Installation] the installation that the instance will use
+    # @param name [String] the name of the instance
+    # @param options [Hash] optional configuration for the instance
+    # @option options :peer (true) +true+ if the locator should act as a peer, otherwise +false+
+    # @option options :port [Integer] (10334) the port that the locator will listen on
+    # @option options :server (true) +true+ if the locator should act as a server, otherwise +false+
+    # @return [LocatorInstance] the new instance
     def create(installation, name, options = {})
       payload = { :installation => installation.location, :name => name }
 
@@ -55,18 +55,23 @@ module Gemfire
   # A locator instance
   class LocatorInstance < Shared::Instance
 
-    def initialize(location, client) #:nodoc:
+    # @private
+    def initialize(location, client)
       super(location, client, Group, Installation, LocatorLiveConfigurations, LocatorPendingConfigurations, LocatorNodeInstance, 'locator-node-instance')
     end
 
     # Updates the instance using the supplied +options+.
     #
-    # Recognized options are:
+    # @param options [Hash] optional configuration for the instance
     #
-    # installation:: The installation to use when running the locator instance. If omitted or nil, the installation configuration will not be changed
-    # peer::         Whether or not the locator will act as a peer. If omitted, the configuration will not be changed
-    # port::         The port on which the locator will listen. If omitted, the port configuration will not be changed
-    # server::       Whether or not the locator will act as a server. If omitted, the configuration will not be changed
+    # @option options :installation [Installation] the installation to be used by the instance.
+    #   If omitted or nil, the installation configuration will not be changed
+    # @option options :peer +true+ if the locator should act as a peer, otherwise +false+.
+    #   If omitted or nil, the installation configuration will not be changed
+    # @option options :port [Integer] the port that the locator will listen on.
+    #   If omitted or nil, the installation configuration will not be changed
+    # @option options :server +true+ if the locator should act as a server, otherwise +false+.
+    #   If omitted or nil, the installation configuration will not be changed
     def update(options)
       payload = {}
 
@@ -89,17 +94,17 @@ module Gemfire
       client.post(location, payload)
     end
 
-    # The port that the locator will listen on
+    # @return [Integer] the port that the locator will listen on
     def port
       client.get(location)['port']
     end
 
-    # +true+ if the locator will act as a peer, +false+ if it will not
+    # @return [Boolean] +true+ if the locator will act as a peer, +false+ if it will not
     def peer
       client.get(location)['peer']
     end
 
-    # +true+ if the locator will act as a server, +false+ if it will not
+    # @return [Boolean] +true+ if the locator will act as a server, +false+ if it will not
     def server
       client.get(location)['server']
     end