[asterisk-scf-commits] asterisk-scf/integration/slice.git branch "locate-with-id" updated.

[Commits to the Asterisk SCF project code repositories]

branch "locate-with-id" has been updated
       via  0328c0ab6c172cacd12e155799576ba2a7b9a993 (commit)
      from  910318fa6ecd6af5aab584664514c886e289d2c6 (commit)

Summary of changes:
 AsteriskSCF/Core/Discovery/ServiceLocatorIf.ice |   44 ++++++++++++++++++++---
 1 files changed, 39 insertions(+), 5 deletions(-)


- Log -----------------------------------------------------------------
commit 0328c0ab6c172cacd12e155799576ba2a7b9a993
Author: Ken Hunt <ken.hunt at digium.com>
Date:   Tue Jun 28 20:21:52 2011 -0500

    Incorporating feedback review. Expand ServiceLocatorParams to include category, service and id.

diff --git a/AsteriskSCF/Core/Discovery/ServiceLocatorIf.ice b/AsteriskSCF/Core/Discovery/ServiceLocatorIf.ice
index fdfb945..e8d5f8a 100644
--- a/AsteriskSCF/Core/Discovery/ServiceLocatorIf.ice
+++ b/AsteriskSCF/Core/Discovery/ServiceLocatorIf.ice
@@ -52,17 +52,51 @@ module V1
 
    /**
     * Generic service locator parameters class that more specific parameter classes can extend.
+    * These parameters are used to register a service with the ServiceLocator, and to 
+    * locate (i.e. query) the service. 
+    * 
+    * Note: The identity of the service is the unique combination of the service field and the
+    * id field, and the id field may be left empty. A service can be part of multiple categories. 
     */
    unsliceable class ServiceLocatorParams
    {
+      /** 
+       * Category for the service.
+       *
+       * When registering a service: 
+       *  - An optional category that the service
+       *    should be considered a member of. The service
+       *    can be added to multiple categories via multiple
+       *    calls to addLocatorParams. 
+       * @see ServiceManagement
+       *
+       * When locating:
+       * - An optional category to filter the results on.
+       */
+      string category; 
+
       /**
-       * Basic category for the service, such as bridge or channel service.
+       * Identifier for the service. 
+       *
+       * When registering a service: 
+       *  - Identifier for the service. Can't be empty. 
+       *
+       * When locating:
+       * - If left empty, locate will return all services within a specified category.
+       * - If category and service are both empty, all services registered with the given
+       *   ServiceLocator are returned. In this case, the id field is ignored. 
        */
-      string category;
+      string service;
 
       /**
-       * Identifier of a specific instance. If left empty the default comparator will 
-       * match on category only. 
+       * Instance id within a replica group. 
+       *
+       * When registering a service:
+       *  - Identifier of a specific service instance. 
+       * 
+       * When locating: 
+       *  - Identifier of a specific instance. If left empty the default 
+       *    comparator will match on service (and category, if set) only. 
        */
        string id;
    };
@@ -73,7 +107,7 @@ module V1
    interface ServiceLocator
    {
       /**
-       * Method which performs a locator request using provided parameters but only returns a single
+       * Method which performs a locator " using provided parameters but only returns a single
        * proxy.
        *
        * @param params A concrete class containing parameters describing the service that is trying to be found.

-----------------------------------------------------------------------


-- 
asterisk-scf/integration/slice.git