You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by sc...@apache.org on 2016/10/16 22:26:29 UTC
[47/51] [abbrv] airavata git commit: fixing id issues
http://git-wip-us.apache.org/repos/asf/airavata/blob/b6e07d7b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
index 9b6253d..ed7fb89 100644
--- a/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
+++ b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
@@ -91,11 +91,13 @@
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to update existing user</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteUser">Function: SharingRegistryService.deleteUser</h4>
-<pre><code>bool</code> deleteUser(<code>string</code> userId)
+<pre><code>bool</code> deleteUser(<code>string</code> domainId,
+ <code>string</code> userId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to delete user</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getUser">Function: SharingRegistryService.getUser</h4>
-<pre><code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> getUser(<code>string</code> userId)
+<pre><code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> getUser(<code>string</code> domainId,
+ <code>string</code> userId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get a user</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getUsers">Function: SharingRegistryService.getUsers</h4>
@@ -116,11 +118,13 @@
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to update a group</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteGroup">Function: SharingRegistryService.deleteGroup</h4>
-<pre><code>bool</code> deleteGroup(<code>string</code> groupId)
+<pre><code>bool</code> deleteGroup(<code>string</code> domainId,
+ <code>string</code> groupId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to delete a group</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroup">Function: SharingRegistryService.getGroup</h4>
-<pre><code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> getGroup(<code>string</code> groupId)
+<pre><code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> getGroup(<code>string</code> domainId,
+ <code>string</code> groupId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get a group</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroups">Function: SharingRegistryService.getGroups</h4>
@@ -129,34 +133,40 @@
<code>i32</code> limit)
</pre><p>API method to get groups in a domainId. Results are reverse sorted based on created time.</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_addUsersToGroup">Function: SharingRegistryService.addUsersToGroup</h4>
-<pre><code>bool</code> addUsersToGroup(<code>list<<code>string</code>></code> userIds,
+<pre><code>bool</code> addUsersToGroup(<code>string</code> domainId,
+ <code>list<<code>string</code>></code> userIds,
<code>string</code> groupId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to add list of users to a group</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_removeUsersFromGroup">Function: SharingRegistryService.removeUsersFromGroup</h4>
-<pre><code>bool</code> removeUsersFromGroup(<code>list<<code>string</code>></code> userIds,
+<pre><code>bool</code> removeUsersFromGroup(<code>string</code> domainId,
+ <code>list<<code>string</code>></code> userIds,
<code>string</code> groupId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to remove users from a group</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroupMembersOfTypeUser">Function: SharingRegistryService.getGroupMembersOfTypeUser</h4>
-<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getGroupMembersOfTypeUser(<code>string</code> groupId,
+<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getGroupMembersOfTypeUser(<code>string</code> domainId,
+ <code>string</code> groupId,
<code>i32</code> offset,
<code>i32</code> limit)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get list of child users in a group. Only the direct members will be returned. Results are reverse time sorted based on creation time</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroupMembersOfTypeGroup">Function: SharingRegistryService.getGroupMembersOfTypeGroup</h4>
-<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getGroupMembersOfTypeGroup(<code>string</code> groupId,
+<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getGroupMembersOfTypeGroup(<code>string</code> domainId,
+ <code>string</code> groupId,
<code>i32</code> offset,
<code>i32</code> limit)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get list of child groups in a group. Only the direct members will be returned. Results are reverse time sorted based on creation time</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_addChildGroupsToParentGroup">Function: SharingRegistryService.addChildGroupsToParentGroup</h4>
-<pre><code>bool</code> addChildGroupsToParentGroup(<code>list<<code>string</code>></code> childIds,
+<pre><code>bool</code> addChildGroupsToParentGroup(<code>string</code> domainId,
+ <code>list<<code>string</code>></code> childIds,
<code>string</code> groupId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to add a child group to a parent group.</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_removeChildGroupFromParentGroup">Function: SharingRegistryService.removeChildGroupFromParentGroup</h4>
-<pre><code>bool</code> removeChildGroupFromParentGroup(<code>string</code> childId,
+<pre><code>bool</code> removeChildGroupFromParentGroup(<code>string</code> domainId,
+ <code>string</code> childId,
<code>string</code> groupId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to remove a child group from parent group.</p>
@@ -169,11 +179,13 @@
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to update entity type</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteEntityType">Function: SharingRegistryService.deleteEntityType</h4>
-<pre><code>bool</code> deleteEntityType(<code>string</code> entityTypeId)
+<pre><code>bool</code> deleteEntityType(<code>string</code> domainId,
+ <code>string</code> entityTypeId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to delete entity type</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getEntityType">Function: SharingRegistryService.getEntityType</h4>
-<pre><code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> getEntityType(<code>string</code> entityTypeId)
+<pre><code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> getEntityType(<code>string</code> domainId,
+ <code>string</code> entityTypeId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get an entity type</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getEntityTypes">Function: SharingRegistryService.getEntityTypes</h4>
@@ -191,15 +203,18 @@
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to update entity</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteEntity">Function: SharingRegistryService.deleteEntity</h4>
-<pre><code>bool</code> deleteEntity(<code>string</code> entityId)
+<pre><code>bool</code> deleteEntity(<code>string</code> domainId,
+ <code>string</code> entityId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to delete entity</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getEntity">Function: SharingRegistryService.getEntity</h4>
-<pre><code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> getEntity(<code>string</code> entityId)
+<pre><code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> getEntity(<code>string</code> domainId,
+ <code>string</code> entityId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get entity</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_searchEntities">Function: SharingRegistryService.searchEntities</h4>
-<pre><code>list<<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code>></code> searchEntities(<code>string</code> userId,
+<pre><code>list<<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code>></code> searchEntities(<code>string</code> domainId,
+ <code>string</code> userId,
<code>string</code> entityTypeId,
<code>list<<code><a href="sharing_models.html#Struct_SearchCriteria">sharing_models.SearchCriteria</a></code>></code> filters,
<code>i32</code> offset,
@@ -207,12 +222,14 @@
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to search entities</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getListOfSharedUsers">Function: SharingRegistryService.getListOfSharedUsers</h4>
-<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getListOfSharedUsers(<code>string</code> entityId,
+<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getListOfSharedUsers(<code>string</code> domainId,
+ <code>string</code> entityId,
<code>string</code> permissionTypeId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get a list of shared users given the entity id</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getListOfSharedGroups">Function: SharingRegistryService.getListOfSharedGroups</h4>
-<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getListOfSharedGroups(<code>string</code> entityId,
+<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getListOfSharedGroups(<code>string</code> domainId,
+ <code>string</code> entityId,
<code>string</code> permissionTypeId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get a list of shared groups given the entity id</p>
@@ -225,11 +242,13 @@
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to update permission type</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deletePermissionType">Function: SharingRegistryService.deletePermissionType</h4>
-<pre><code>bool</code> deletePermissionType(<code>string</code> entityTypeId)
+<pre><code>bool</code> deletePermissionType(<code>string</code> domainId,
+ <code>string</code> permissionTypeId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to delete permission type</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getPermissionType">Function: SharingRegistryService.getPermissionType</h4>
-<pre><code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> getPermissionType(<code>string</code> permissionTypeId)
+<pre><code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> getPermissionType(<code>string</code> domainId,
+ <code>string</code> permissionTypeId)
throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
</pre><p>API method to get permission type</p>
<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getPermissionTypes">Function: SharingRegistryService.getPermissionTypes</h4>
http://git-wip-us.apache.org/repos/asf/airavata/blob/b6e07d7b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
index 1d4dff8..5065c95 100644
--- a/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
+++ b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
@@ -145,7 +145,7 @@ will be same as the domain name</p>
<tr><td>9</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>User is the model used to register a user in the system. Minimal user information will be required to provide
regarding the user.</p>
-<li><b>userId</b> : Client provided user id. (The id is not system generated and it is a must to provide this id)</li>
+<li><b>userId</b> : User id provided by the client</li>
<li><b>domainId</b> : Domain id for that user</li>
<li><b>userName</b> : User name for the user</li>
<li><b>firstName</b> : First name of the user</li>
@@ -157,7 +157,7 @@ regarding the user.</p>
<br/></div><div class="definition"><h3 id="Struct_UserGroup">Struct: UserGroup</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>groupId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>1</td><td>groupId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
@@ -167,7 +167,7 @@ regarding the user.</p>
<tr><td>8</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>User group is a collection of users.</p>
- <li>groupId : System generated grouo id. In the current implementation this is of the form domainId:name</li>
+ <li><b>groupId</b> : Group id provided by the client</li>
<li><b>domainId</b> : Domain id for this user group</li>
<li><b>name</b> : Name for the user group. should be one word</li>
<li>description : Short description for the group.</li>
@@ -181,21 +181,22 @@ regarding the user.</p>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>parentId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>childId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>3</td><td>childType</td><td><code><a href="#Enum_GroupChildType">GroupChildType</a></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>4</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>5</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>childType</td><td><code><a href="#Enum_GroupChildType">GroupChildType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>System internal data type to map group memberships</p>
<br/></div><div class="definition"><h3 id="Struct_EntityType">Struct: EntityType</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>entityTypeId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>1</td><td>entityTypeId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>client defined entity types</p>
-<li>entityTypeId : System generated entity type id. In the current implementation it will of the form domainId:name</li>
+<li><b>entityTypeId</b> : Entity type id provided by the client</li>
<li><b>domainId</b> : Domain id of the domain.</li>
<li><b>name</b> : Name for the entity type. Should be a single word.</li>
<li>description : Short description for the entity type.</li>
@@ -221,33 +222,33 @@ regarding the user.</p>
<tr><td>5</td><td>parentEntityId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>8</td><td>metadata</td><td><code>map<<code>string</code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>binaryData</td><td><code>binary</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>fullText</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>10</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>11</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>Entity object which is used to register an entity in the system.</p>
-<li><b>entityId</b> : Client id provided by the client</li>
+<li><b>entityId</b> : Entity id provided by the client</li>
<li><b>domainId</b> : Domain id</li>
<li><b>entityTypeId</b> : Entity type id</li>
<li><b>ownerId</b> : Owner id</li>
<li>parentEntityId : Parent entity id</li>
<li><b>name</b> : Name</li>
<li>description : Short description for the entity</li>
-<li>metadata : Map of optional metadata</li>
+<li>binaryData : Any information stored in binary format</li>
<li>fullText : A string which will be considered for full text search</li>
<li>createdTime : If client provides this value then the system will use it if not the current time will be set</li>
<li>updatedTime : If client provides this value then the system will use it if not the current time will be set</li>
<br/></div><div class="definition"><h3 id="Struct_PermissionType">Struct: PermissionType</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>permissionTypeId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>1</td><td>permissionTypeId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>Object for creating client defined permission type</p>
-<li>permissionTypeId : System generated permission type id. In the current implementation it will of the form domainId:name</li>
+<li><b>permissionTypeId</b> : Permission type id provided by the client</li>
<li><b>domainId</b> : Domain id</li>
<li><b>name</b> : Single word name for the permission</li>
<li>description : Short description for the permission type</li>
@@ -260,9 +261,10 @@ regarding the user.</p>
<tr><td>2</td><td>entityId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>groupId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>sharingType</td><td><code><a href="#Enum_SharingType">SharingType</a></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>5</td><td>inheritedParentId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>6</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>7</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>inheritedParentId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</table><br/><p>This is an internal enum type for managing sharings</p>
<br/></div><div class="definition"><h3 id="Struct_SharingRegistryException">Exception: SharingRegistryException</h3>
http://git-wip-us.apache.org/repos/asf/airavata/blob/b6e07d7b/modules/sharing-registry/sharing-service-docs/index.html
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-service-docs/index.html b/modules/sharing-registry/sharing-service-docs/index.html
index 14f730b..d7a7868 100644
--- a/modules/sharing-registry/sharing-service-docs/index.html
+++ b/modules/sharing-registry/sharing-service-docs/index.html
@@ -7,7 +7,8 @@
<div class="container-fluid">
<h2>Welcome to Airavata Sharing Registry Service Documentation</h2>
- <p>Airavata Data Sharing Registry Service is a general purpose data sharing and access controlling service.</p>
+ <p>Airavata Data Sharing Registry Service is a general purpose <em>Collaborative User Space Management Component</em> that can solve
+ your Scientific Data Management requirements related to sharing and access controlling.</p>
<div>
<ul><a href="#getting-started">Getting Started</a></ul>
http://git-wip-us.apache.org/repos/asf/airavata/blob/b6e07d7b/modules/sharing-registry/thrift_models/sharing_cpi.thrift
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/thrift_models/sharing_cpi.thrift b/modules/sharing-registry/thrift_models/sharing_cpi.thrift
index 274eb4b..f180738 100644
--- a/modules/sharing-registry/thrift_models/sharing_cpi.thrift
+++ b/modules/sharing-registry/thrift_models/sharing_cpi.thrift
@@ -56,11 +56,11 @@ service SharingRegistryService {
/**
<p>API method to delete user</p>
*/
- bool deleteUser(1: required string userId) throws (1: sharing_models.SharingRegistryException sre)
+ bool deleteUser(1: required string domainId, 2: required string userId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get a user</p>
*/
- sharing_models.User getUser(1: required string userId) throws (1: sharing_models.SharingRegistryException sre)
+ sharing_models.User getUser(1: required string domainId, 2: required string userId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get a list of users in a specific domain Users will be reverse sorted based on the created time.</p>
<li>domainId : Domain id</li>
@@ -80,11 +80,11 @@ service SharingRegistryService {
/**
<p>API method to delete a group</p>
*/
- bool deleteGroup(1: required string groupId) throws (1: sharing_models.SharingRegistryException sre)
+ bool deleteGroup(1: required string domainId, 2: required string groupId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get a group</p>
*/
- sharing_models.UserGroup getGroup(1: required string groupId) throws (1: sharing_models.SharingRegistryException sre)
+ sharing_models.UserGroup getGroup(1: required string domainId, 2: required string groupId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get groups in a domainId. Results are reverse sorted based on created time.</p>
*/
@@ -93,27 +93,27 @@ service SharingRegistryService {
/**
<p>API method to add list of users to a group</p>
*/
- bool addUsersToGroup(1: required list<string> userIds, 2: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
+ bool addUsersToGroup(1: required string domainId, 2: required list<string> userIds, 3: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
/**
<p>API method to remove users from a group</p>
*/
- bool removeUsersFromGroup(1: required list<string> userIds, 2: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
+ bool removeUsersFromGroup(1: required string domainId, 2: required list<string> userIds, 3: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
/**
<p>API method to get list of child users in a group. Only the direct members will be returned. Results are reverse time sorted based on creation time</p>
*/
- list<sharing_models.User> getGroupMembersOfTypeUser(1: required string groupId, 2: required i32 offset, 3: required i32 limit) throws (1: sharing_models.SharingRegistryException sre);
+ list<sharing_models.User> getGroupMembersOfTypeUser(1: string domainId, 2: required string groupId, 3: required i32 offset, 4: required i32 limit) throws (1: sharing_models.SharingRegistryException sre);
/**
<p>API method to get list of child groups in a group. Only the direct members will be returned. Results are reverse time sorted based on creation time</p>
*/
- list<sharing_models.UserGroup> getGroupMembersOfTypeGroup(1: required string groupId, 2: required i32 offset, 3: required i32 limit) throws (1: sharing_models.SharingRegistryException sre);
+ list<sharing_models.UserGroup> getGroupMembersOfTypeGroup(1: required string domainId, 2: required string groupId, 3: required i32 offset, 4: required i32 limit) throws (1: sharing_models.SharingRegistryException sre);
/**
<p>API method to add a child group to a parent group.</p>
*/
- bool addChildGroupsToParentGroup(1: required list<string> childIds, 2: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
+ bool addChildGroupsToParentGroup(1: required string domainId, 2: required list<string> childIds, 3: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
/**
<p>API method to remove a child group from parent group.</p>
*/
- bool removeChildGroupFromParentGroup(1: required string childId, 2: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
+ bool removeChildGroupFromParentGroup(1: required string domainId, 2: required string childId, 3: required string groupId) throws (1: sharing_models.SharingRegistryException sre);
/**
<p>API method to create a new entity type</p>
@@ -126,11 +126,11 @@ service SharingRegistryService {
/**
<p>API method to delete entity type</p>
*/
- bool deleteEntityType(1: required string entityTypeId) throws (1: sharing_models.SharingRegistryException sre)
+ bool deleteEntityType(1: required string domainId, 2: required string entityTypeId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get an entity type</p>
*/
- sharing_models.EntityType getEntityType(1: required string entityTypeId) throws (1: sharing_models.SharingRegistryException sre)
+ sharing_models.EntityType getEntityType(1: required string domainId, 2: required string entityTypeId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get entity types in a domainId. Results are reverse time sorted based on creation time</p>
*/
@@ -148,23 +148,23 @@ service SharingRegistryService {
/**
<p>API method to delete entity</p>
*/
- bool deleteEntity(1: required string entityId) throws (1: sharing_models.SharingRegistryException sre)
+ bool deleteEntity(1: required string domainId, 2: required string entityId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get entity</p>
*/
- sharing_models.Entity getEntity(1: required string entityId) throws (1: sharing_models.SharingRegistryException sre)
+ sharing_models.Entity getEntity(1: required string domainId, 2: required string entityId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to search entities</p>
*/
- list<sharing_models.Entity> searchEntities(1: required string userId, 2: required string entityTypeId, 3: required list<sharing_models.SearchCriteria> filters, 4: required i32 offset, 5: required i32 limit) throws (1: sharing_models.SharingRegistryException sre)
+ list<sharing_models.Entity> searchEntities(1: required string domainId, 2: required string userId, 3: required string entityTypeId, 4: required list<sharing_models.SearchCriteria> filters, 5: required i32 offset, 6: required i32 limit) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get a list of shared users given the entity id</p>
*/
- list<sharing_models.User> getListOfSharedUsers(1: required string entityId, 2: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
+ list<sharing_models.User> getListOfSharedUsers(1: required string domainId, 2: required string entityId, 3: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get a list of shared groups given the entity id</p>
*/
- list<sharing_models.UserGroup> getListOfSharedGroups(1: required string entityId, 2: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
+ list<sharing_models.UserGroup> getListOfSharedGroups(1: required string domainId, 2: required string entityId, 3: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to create permission type</p>
@@ -177,11 +177,11 @@ service SharingRegistryService {
/**
<p>API method to delete permission type</p>
*/
- bool deletePermissionType(1: required string entityTypeId) throws (1: sharing_models.SharingRegistryException sre)
+ bool deletePermissionType(1: required string domainId, 2: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get permission type</p>
*/
- sharing_models.PermissionType getPermissionType(1: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
+ sharing_models.PermissionType getPermissionType(1: required string domainId, 2: required string permissionTypeId) throws (1: sharing_models.SharingRegistryException sre)
/**
<p>API method to get list of permission types in a given domainId. Results are reverse time sorted based on creation time</p>
*/
http://git-wip-us.apache.org/repos/asf/airavata/blob/b6e07d7b/modules/sharing-registry/thrift_models/sharing_models.thrift
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/thrift_models/sharing_models.thrift b/modules/sharing-registry/thrift_models/sharing_models.thrift
index f8c6f31..d4d15c4 100644
--- a/modules/sharing-registry/thrift_models/sharing_models.thrift
+++ b/modules/sharing-registry/thrift_models/sharing_models.thrift
@@ -43,7 +43,7 @@ struct Domain {
/**
* <p>User is the model used to register a user in the system. Minimal user information will be required to provide
* regarding the user.</p>
-* <li><b>userId</b> : Client provided user id. (The id is not system generated and it is a must to provide this id)</li>
+* <li><b>userId</b> : User id provided by the client</li>
* <li><b>domainId</b> : Domain id for that user</li>
* <li><b>userName</b> : User name for the user</li>
* <li><b>firstName</b> : First name of the user</li>
@@ -84,7 +84,7 @@ enum GroupType {
/**
*<p>User group is a collection of users.</p>
-* <li>groupId : System generated grouo id. In the current implementation this is of the form domainId:name</li>
+* <li><b>groupId</b> : Group id provided by the client</li>
* <li><b>domainId</b> : Domain id for this user group</li>
* <li><b>name</b> : Name for the user group. should be one word</li>
* <li>description : Short description for the group.</li>
@@ -95,7 +95,7 @@ enum GroupType {
* <li>updatedTime : Will be set by the system</li>
**/
struct UserGroup {
- 1: optional string groupId = DO_NOT_SET_AT_CLIENTS_ID,
+ 1: optional string groupId,
2: optional string domainId,
3: optional string name,
4: optional string description,
@@ -118,17 +118,18 @@ enum GroupChildType {
* <p>System internal data type to map group memberships</p>
**/
struct GroupMembership {
-1: optional string parentId,
-2: optional string childId,
-3: optional GroupChildType childType
-4: optional i64 createdTime,
-5: optional i64 updatedTime
+ 1: optional string parentId,
+ 2: optional string childId,
+ 3: optional string domainId,
+ 4: optional GroupChildType childType
+ 5: optional i64 createdTime,
+ 6: optional i64 updatedTime
}
/**
* <p>client defined entity types</p>
-* <li>entityTypeId : System generated entity type id. In the current implementation it will of the form domainId:name</li>
+* <li><b>entityTypeId</b> : Entity type id provided by the client</li>
* <li><b>domainId</b> : Domain id of the domain.</li>
* <li><b>name</b> : Name for the entity type. Should be a single word.</li>
* <li>description : Short description for the entity type.</li>
@@ -136,7 +137,7 @@ struct GroupMembership {
* <li>updatedTime : Will be set by the system</li>
**/
struct EntityType {
- 1: optional string entityTypeId = DO_NOT_SET_AT_CLIENTS_ID,
+ 1: optional string entityTypeId,
2: optional string domainId,
3: optional string name,
4: optional string description,
@@ -192,14 +193,14 @@ struct SearchCriteria {
/**
* <p>Entity object which is used to register an entity in the system.</p>
-* <li><b>entityId</b> : Client id provided by the client</li>
+* <li><b>entityId</b> : Entity id provided by the client</li>
* <li><b>domainId</b> : Domain id</li>
* <li><b>entityTypeId</b> : Entity type id</li>
* <li><b>ownerId</b> : Owner id</li>
* <li>parentEntityId : Parent entity id</li>
* <li><b>name</b> : Name</li>
* <li>description : Short description for the entity</li>
-* <li>metadata : Map of optional metadata</li>
+* <li>binaryData : Any information stored in binary format</li>
* <li>fullText : A string which will be considered for full text search</li>
* <li>createdTime : If client provides this value then the system will use it if not the current time will be set</li>
* <li>updatedTime : If client provides this value then the system will use it if not the current time will be set</li>
@@ -212,7 +213,7 @@ struct Entity {
5: optional string parentEntityId,
6: optional string name,
7: optional string description,
- 8: optional map<string,string> metadata,
+ 8: optional binary binaryData,
9: optional string fullText,
10: optional i64 createdTime,
11: optional i64 updatedTime
@@ -220,7 +221,7 @@ struct Entity {
/**
* <p>Object for creating client defined permission type</p>
-* <li>permissionTypeId : System generated permission type id. In the current implementation it will of the form domainId:name</li>
+* <li><b>permissionTypeId</b> : Permission type id provided by the client</li>
* <li><b>domainId</b> : Domain id</li>
* <li><b>name</b> : Single word name for the permission</li>
* <li>description : Short description for the permission type</li>
@@ -228,7 +229,7 @@ struct Entity {
* <li>updatedTime : Will be set by the system</li>
**/
struct PermissionType {
- 1: optional string permissionTypeId = DO_NOT_SET_AT_CLIENTS_ID,
+ 1: optional string permissionTypeId,
2: optional string domainId,
3: optional string name,
4: optional string description,
@@ -253,9 +254,10 @@ struct Sharing {
2: optional string entityId,
3: optional string groupId,
4: optional SharingType sharingType,
- 5: optional string inheritedParentId,
- 6: optional i64 createdTime,
- 7: optional i64 updatedTime
+ 5: optional string domainId,
+ 6: optional string inheritedParentId,
+ 7: optional i64 createdTime,
+ 8: optional i64 updatedTime
}
/**