adding initial how to use documents
Project: http://git-wip-us.apache.org/repos/asf/airavata/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata/commit/61a0fc95 Tree: http://git-wip-us.apache.org/repos/asf/airavata/tree/61a0fc95 Diff: http://git-wip-us.apache.org/repos/asf/airavata/diff/61a0fc95 Branch: refs/heads/develop Commit: 61a0fc95416a658fae5164165e67bd896dc228fb Parents: 6718761 Author: scnakandala <supun.nakand...@gmail.com> Authored: Fri Oct 14 20:03:16 2016 -0400 Committer: scnakandala <supun.nakand...@gmail.com> Committed: Fri Oct 14 20:03:16 2016 -0400 ---------------------------------------------------------------------- modules/sharing-registry/api-docs/index.html | 79 ----- .../sharing-registry/api-docs/sharing_cpi.html | 278 ----------------- .../api-docs/sharing_models.html | 273 ----------------- modules/sharing-registry/api-docs/style.css | 184 ------------ .../registry/SharingRegistryServiceTest.java | 84 ++++++ .../service/cpi/SharingRegistryService.java | 296 +++++++++---------- .../sharing-service-docs/api-docs/index.html | 79 +++++ .../api-docs/sharing_cpi.html | 278 +++++++++++++++++ .../api-docs/sharing_models.html | 273 +++++++++++++++++ .../sharing-service-docs/api-docs/style.css | 184 ++++++++++++ .../sharing-service-docs/index.html | 93 ++++++ .../sharing-service-docs/style.css | 184 ++++++++++++ .../thrift_models/sharing_cpi.thrift | 4 +- .../thrift_models/thrift-gen.sh | 4 +- 14 files changed, 1327 insertions(+), 966 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/api-docs/index.html ---------------------------------------------------------------------- diff --git a/modules/sharing-registry/api-docs/index.html b/modules/sharing-registry/api-docs/index.html deleted file mode 100644 index 6663a9d..0000000 --- a/modules/sharing-registry/api-docs/index.html +++ /dev/null @@ -1,79 +0,0 @@ -<html><head> -<link href="style.css" rel="stylesheet" type="text/css"/> -<title>All Thrift declarations</title></head><body> -<div class="container-fluid"> -<h1>All Thrift declarations</h1> -<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> -<tr> -<td>sharing_cpi</td><td><a href="sharing_cpi.html#Svc_SharingRegistryService">SharingRegistryService</a><br/> -<ul> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_addChildGroupsToParentGroup">addChildGroupsToParentGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_addUsersToGroup">addUsersToGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createDomain">createDomain</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createEntityType">createEntityType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createGroup">createGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createPermissionType">createPermissionType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteDomain">deleteDomain</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteEntity">deleteEntity</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteEntityType">deleteEntityType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteGroup">deleteGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deletePermissionType">deletePermissionType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteUser">deleteUser</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getDomain">getDomain</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getDomains">getDomains</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getEntity">getEntity</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getEntityType">getEntityType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getEntityTypes">getEntityTypes</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroup">getGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroupMembersOfTypeGroup">getGroupMembersOfTypeGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroupMembersOfTypeUser">getGroupMembersOfTypeUser</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroups">getGroups</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getListOfSharedGroups">getListOfSharedGroups</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getListOfSharedUsers">getListOfSharedUsers</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getPermissionType">getPermissionType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getPermissionTypes">getPermissionTypes</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getUser">getUser</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getUsers">getUsers</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_registerEntity">registerEntity</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_registerUser">registerUser</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_removeChildGroupFromParentGroup">removeChildGroupFromParentGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_removeUsersFromGroup">removeUsersFromGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_revokeEntitySharingFromGroups">revokeEntitySharingFromGroups</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_revokeEntitySharingFromUsers">revokeEntitySharingFromUsers</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_searchEntities">searchEntities</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_shareEntityWithGroups">shareEntityWithGroups</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_shareEntityWithUsers">shareEntityWithUsers</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateDomain">updateDomain</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateEntity">updateEntity</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateEntityType">updateEntityType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateGroup">updateGroup</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updatePermissionType">updatePermissionType</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updatedUser">updatedUser</a></li> -<li><a href="sharing_cpi.html#Fn_SharingRegistryService_userHasAccess">userHasAccess</a></li> -</ul> -</td> -<td></td> -<td></code></td> -</tr><tr> -<td>sharing_models</td><td></td> -<td><a href="sharing_models.html#Struct_Domain">Domain</a><br/> -<a href="sharing_models.html#Struct_Entity">Entity</a><br/> -<a href="sharing_models.html#Enum_EntitySearchField">EntitySearchField</a><br/> -<a href="sharing_models.html#Struct_EntityType">EntityType</a><br/> -<a href="sharing_models.html#Enum_GroupCardinality">GroupCardinality</a><br/> -<a href="sharing_models.html#Enum_GroupChildType">GroupChildType</a><br/> -<a href="sharing_models.html#Struct_GroupMembership">GroupMembership</a><br/> -<a href="sharing_models.html#Enum_GroupType">GroupType</a><br/> -<a href="sharing_models.html#Struct_PermissionType">PermissionType</a><br/> -<a href="sharing_models.html#Enum_SearchCondition">SearchCondition</a><br/> -<a href="sharing_models.html#Struct_SearchCriteria">SearchCriteria</a><br/> -<a href="sharing_models.html#Struct_Sharing">Sharing</a><br/> -<a href="sharing_models.html#Struct_SharingRegistryException">SharingRegistryException</a><br/> -<a href="sharing_models.html#Enum_SharingType">SharingType</a><br/> -<a href="sharing_models.html#Struct_User">User</a><br/> -<a href="sharing_models.html#Struct_UserGroup">UserGroup</a><br/> -</td> -<td><code><a href="sharing_models.html#Const_DO_NOT_SET_AT_CLIENTS_ID">DO_NOT_SET_AT_CLIENTS_ID</a></code><br/> -</code></td> -</tr></table> -</div></body></html> http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/api-docs/sharing_cpi.html ---------------------------------------------------------------------- diff --git a/modules/sharing-registry/api-docs/sharing_cpi.html b/modules/sharing-registry/api-docs/sharing_cpi.html deleted file mode 100644 index 037f75e..0000000 --- a/modules/sharing-registry/api-docs/sharing_cpi.html +++ /dev/null @@ -1,278 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> -<link href="style.css" rel="stylesheet" type="text/css"/> -<title>Thrift module: sharing_cpi</title></head><body> -<div class="container-fluid"> -<h1>Thrift module: sharing_cpi</h1> -<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> -<tr> -<td>sharing_cpi</td><td><a href="#Svc_SharingRegistryService">SharingRegistryService</a><br/> -<ul> -<li><a href="#Fn_SharingRegistryService_addChildGroupsToParentGroup">addChildGroupsToParentGroup</a></li> -<li><a href="#Fn_SharingRegistryService_addUsersToGroup">addUsersToGroup</a></li> -<li><a href="#Fn_SharingRegistryService_createDomain">createDomain</a></li> -<li><a href="#Fn_SharingRegistryService_createEntityType">createEntityType</a></li> -<li><a href="#Fn_SharingRegistryService_createGroup">createGroup</a></li> -<li><a href="#Fn_SharingRegistryService_createPermissionType">createPermissionType</a></li> -<li><a href="#Fn_SharingRegistryService_deleteDomain">deleteDomain</a></li> -<li><a href="#Fn_SharingRegistryService_deleteEntity">deleteEntity</a></li> -<li><a href="#Fn_SharingRegistryService_deleteEntityType">deleteEntityType</a></li> -<li><a href="#Fn_SharingRegistryService_deleteGroup">deleteGroup</a></li> -<li><a href="#Fn_SharingRegistryService_deletePermissionType">deletePermissionType</a></li> -<li><a href="#Fn_SharingRegistryService_deleteUser">deleteUser</a></li> -<li><a href="#Fn_SharingRegistryService_getDomain">getDomain</a></li> -<li><a href="#Fn_SharingRegistryService_getDomains">getDomains</a></li> -<li><a href="#Fn_SharingRegistryService_getEntity">getEntity</a></li> -<li><a href="#Fn_SharingRegistryService_getEntityType">getEntityType</a></li> -<li><a href="#Fn_SharingRegistryService_getEntityTypes">getEntityTypes</a></li> -<li><a href="#Fn_SharingRegistryService_getGroup">getGroup</a></li> -<li><a href="#Fn_SharingRegistryService_getGroupMembersOfTypeGroup">getGroupMembersOfTypeGroup</a></li> -<li><a href="#Fn_SharingRegistryService_getGroupMembersOfTypeUser">getGroupMembersOfTypeUser</a></li> -<li><a href="#Fn_SharingRegistryService_getGroups">getGroups</a></li> -<li><a href="#Fn_SharingRegistryService_getListOfSharedGroups">getListOfSharedGroups</a></li> -<li><a href="#Fn_SharingRegistryService_getListOfSharedUsers">getListOfSharedUsers</a></li> -<li><a href="#Fn_SharingRegistryService_getPermissionType">getPermissionType</a></li> -<li><a href="#Fn_SharingRegistryService_getPermissionTypes">getPermissionTypes</a></li> -<li><a href="#Fn_SharingRegistryService_getUser">getUser</a></li> -<li><a href="#Fn_SharingRegistryService_getUsers">getUsers</a></li> -<li><a href="#Fn_SharingRegistryService_registerEntity">registerEntity</a></li> -<li><a href="#Fn_SharingRegistryService_registerUser">registerUser</a></li> -<li><a href="#Fn_SharingRegistryService_removeChildGroupFromParentGroup">removeChildGroupFromParentGroup</a></li> -<li><a href="#Fn_SharingRegistryService_removeUsersFromGroup">removeUsersFromGroup</a></li> -<li><a href="#Fn_SharingRegistryService_revokeEntitySharingFromGroups">revokeEntitySharingFromGroups</a></li> -<li><a href="#Fn_SharingRegistryService_revokeEntitySharingFromUsers">revokeEntitySharingFromUsers</a></li> -<li><a href="#Fn_SharingRegistryService_searchEntities">searchEntities</a></li> -<li><a href="#Fn_SharingRegistryService_shareEntityWithGroups">shareEntityWithGroups</a></li> -<li><a href="#Fn_SharingRegistryService_shareEntityWithUsers">shareEntityWithUsers</a></li> -<li><a href="#Fn_SharingRegistryService_updateDomain">updateDomain</a></li> -<li><a href="#Fn_SharingRegistryService_updateEntity">updateEntity</a></li> -<li><a href="#Fn_SharingRegistryService_updateEntityType">updateEntityType</a></li> -<li><a href="#Fn_SharingRegistryService_updateGroup">updateGroup</a></li> -<li><a href="#Fn_SharingRegistryService_updatePermissionType">updatePermissionType</a></li> -<li><a href="#Fn_SharingRegistryService_updatedUser">updatedUser</a></li> -<li><a href="#Fn_SharingRegistryService_userHasAccess">userHasAccess</a></li> -</ul> -</td> -<td></td> -<td></code></td> -</tr></table> -<hr/><h2 id="Services">Services</h2> -<h3 id="Svc_SharingRegistryService">Service: SharingRegistryService</h3> -<div class="definition"><h4 id="Fn_SharingRegistryService_createDomain">Function: SharingRegistryService.createDomain</h4> -<pre><code>string</code> createDomain(<code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code> domainId) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to create a new domain</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateDomain">Function: SharingRegistryService.updateDomain</h4> -<pre><code>bool</code> updateDomain(<code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code> domainId) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to update a domain</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteDomain">Function: SharingRegistryService.deleteDomain</h4> -<pre><code>bool</code> deleteDomain(<code>string</code> domainId) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to delete domain</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getDomain">Function: SharingRegistryService.getDomain</h4> -<pre><code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code> getDomain(<code>string</code> domainId) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to retrieve a domain</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getDomains">Function: SharingRegistryService.getDomains</h4> -<pre><code>list<<code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code>></code> getDomains(<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 all domain.</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_registerUser">Function: SharingRegistryService.registerUser</h4> -<pre><code>string</code> registerUser(<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> user) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to register a user in the system</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updatedUser">Function: SharingRegistryService.updatedUser</h4> -<pre><code>bool</code> updatedUser(<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> user) - 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) - 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) - 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> -<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getUsers(<code>string</code> domainId, - <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 a list of users in a specific domain Users will be reverse sorted based on the created time.</p> -<li>domainId : Domain id</li> -<li>offset : Starting result number</li> -<li>limit : Number of max results to be sent</li> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_createGroup">Function: SharingRegistryService.createGroup</h4> -<pre><code>string</code> createGroup(<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> group) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to create a new group</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateGroup">Function: SharingRegistryService.updateGroup</h4> -<pre><code>bool</code> updateGroup(<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> group) - 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) - 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) - 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> -<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getGroups(<code>string</code> domainId, - <code>i32</code> offset, - <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, - <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, - <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, - <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, - <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, - <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, - <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> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_createEntityType">Function: SharingRegistryService.createEntityType</h4> -<pre><code>string</code> createEntityType(<code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> entityType) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to create a new entity type</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateEntityType">Function: SharingRegistryService.updateEntityType</h4> -<pre><code>bool</code> updateEntityType(<code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> entityType) - 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) - 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) - 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> -<pre><code>list<<code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code>></code> getEntityTypes(<code>string</code> domainId, - <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 entity types in a domainId. Results are reverse time sorted based on creation time</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_registerEntity">Function: SharingRegistryService.registerEntity</h4> -<pre><code>string</code> registerEntity(<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> entity) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to register new entity</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateEntity">Function: SharingRegistryService.updateEntity</h4> -<pre><code>bool</code> updateEntity(<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> entity) - 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) - 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) - 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, - <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, - <code>i32</code> limit) - 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, - <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, - <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> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_createPermissionType">Function: SharingRegistryService.createPermissionType</h4> -<pre><code>string</code> createPermissionType(<code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> permissionType) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to create permission type</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updatePermissionType">Function: SharingRegistryService.updatePermissionType</h4> -<pre><code>bool</code> updatePermissionType(<code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> permissionType) - 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) - 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) - 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> -<pre><code>list<<code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code>></code> getPermissionTypes(<code>string</code> domainId, - <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 permission types in a given domainId. Results are reverse time sorted based on creation time</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_shareEntityWithUsers">Function: SharingRegistryService.shareEntityWithUsers</h4> -<pre><code>bool</code> shareEntityWithUsers(<code>string</code> domainId, - <code>string</code> entityId, - <code>list<<code>string</code>></code> userList, - <code>string</code> perssionTypeId, - <code>bool</code> cascadePermission) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to share an entity with users</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_revokeEntitySharingFromUsers">Function: SharingRegistryService.revokeEntitySharingFromUsers</h4> -<pre><code>bool</code> revokeEntitySharingFromUsers(<code>string</code> domainId, - <code>string</code> entityId, - <code>list<<code>string</code>></code> userList, - <code>string</code> perssionTypeId) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to revoke sharing from a list of users</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_shareEntityWithGroups">Function: SharingRegistryService.shareEntityWithGroups</h4> -<pre><code>bool</code> shareEntityWithGroups(<code>string</code> domainId, - <code>string</code> entityId, - <code>list<<code>string</code>></code> groupList, - <code>string</code> perssionTypeId, - <code>bool</code> cascadePermission) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to share an entity with list of groups</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_revokeEntitySharingFromGroups">Function: SharingRegistryService.revokeEntitySharingFromGroups</h4> -<pre><code>bool</code> revokeEntitySharingFromGroups(<code>string</code> domainId, - <code>string</code> entityId, - <code>list<<code>string</code>></code> groupList, - <code>string</code> perssionTypeId) - throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code> -</pre><p>API method to revoke sharing from list of users</p> -<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_userHasAccess">Function: SharingRegistryService.userHasAccess</h4> -<pre><code>bool</code> userHasAccess(<code>string</code> domainId, - <code>string</code> userId, - <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 check whether a user has access to a specific entity</p> -<br/></div></div></body></html> http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/api-docs/sharing_models.html ---------------------------------------------------------------------- diff --git a/modules/sharing-registry/api-docs/sharing_models.html b/modules/sharing-registry/api-docs/sharing_models.html deleted file mode 100644 index 1d4dff8..0000000 --- a/modules/sharing-registry/api-docs/sharing_models.html +++ /dev/null @@ -1,273 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> -<link href="style.css" rel="stylesheet" type="text/css"/> -<title>Thrift module: sharing_models</title></head><body> -<div class="container-fluid"> -<h1>Thrift module: sharing_models</h1> -<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> -<tr> -<td>sharing_models</td><td></td> -<td><a href="#Struct_Domain">Domain</a><br/> -<a href="#Struct_Entity">Entity</a><br/> -<a href="#Enum_EntitySearchField">EntitySearchField</a><br/> -<a href="#Struct_EntityType">EntityType</a><br/> -<a href="#Enum_GroupCardinality">GroupCardinality</a><br/> -<a href="#Enum_GroupChildType">GroupChildType</a><br/> -<a href="#Struct_GroupMembership">GroupMembership</a><br/> -<a href="#Enum_GroupType">GroupType</a><br/> -<a href="#Struct_PermissionType">PermissionType</a><br/> -<a href="#Enum_SearchCondition">SearchCondition</a><br/> -<a href="#Struct_SearchCriteria">SearchCriteria</a><br/> -<a href="#Struct_Sharing">Sharing</a><br/> -<a href="#Struct_SharingRegistryException">SharingRegistryException</a><br/> -<a href="#Enum_SharingType">SharingType</a><br/> -<a href="#Struct_User">User</a><br/> -<a href="#Struct_UserGroup">UserGroup</a><br/> -</td> -<td><code><a href="#Const_DO_NOT_SET_AT_CLIENTS_ID">DO_NOT_SET_AT_CLIENTS_ID</a></code><br/> -</code></td> -</tr></table> -<hr/><h2 id="Constants">Constants</h2> -<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead> -<tr id="Const_DO_NOT_SET_AT_CLIENTS_ID"><td><code>DO_NOT_SET_AT_CLIENTS_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr></table><hr/><h2 id="Enumerations">Enumerations</h2> -<div class="definition"><h3 id="Enum_GroupCardinality">Enumeration: GroupCardinality</h3> -<p>This is an system internal enum used to define single user groups and multi users groups. Every user is also -considered as a group in it's own right for implementation ease</p> - -<br/><br/><table class="table-bordered table-striped table-condensed"> -<tr><td><code>SINGLE_USER</code></td><td><code>0</code></td><td> -</td></tr> -<tr><td><code>MULTI_USER</code></td><td><code>1</code></td><td> -</td></tr> -</table></div> -<div class="definition"><h3 id="Enum_GroupType">Enumeration: GroupType</h3> -<p>Group types can be either user level or domain level groups.</p> - -<br/><br/><table class="table-bordered table-striped table-condensed"> -<tr><td><code>DOMAIN_LEVEL_GROUP</code></td><td><code>0</code></td><td> -</td></tr> -<tr><td><code>USER_LEVEL_GROUP</code></td><td><code>1</code></td><td> -</td></tr> -</table></div> -<div class="definition"><h3 id="Enum_GroupChildType">Enumeration: GroupChildType</h3> -<p>System internal data type to match group child types</p> - -<br/><br/><table class="table-bordered table-striped table-condensed"> -<tr><td><code>USER</code></td><td><code>0</code></td><td> -</td></tr> -<tr><td><code>GROUP</code></td><td><code>1</code></td><td> -</td></tr> -</table></div> -<div class="definition"><h3 id="Enum_EntitySearchField">Enumeration: EntitySearchField</h3> -<p>This list of fields that can be used to search entities</p> -<li>NAME : Name of the entity</li> -<li>DESCRIPTION : Description of the entity</li> -<li>FULL_TEXT : Full text field of the entity</li> -<li>PARENT_ENTITY_ID : Parent entity id of the entity</li> -<li>CREATED_TIME : Created time of the entity</li> -<li>UPDATED_TIME : Updated time of the entity</li> - -<br/><br/><table class="table-bordered table-striped table-condensed"> -<tr><td><code>NAME</code></td><td><code>0</code></td><td> -</td></tr> -<tr><td><code>DESCRIPTION</code></td><td><code>1</code></td><td> -</td></tr> -<tr><td><code>FULL_TEXT</code></td><td><code>2</code></td><td> -</td></tr> -<tr><td><code>PRRENT_ENTITY_ID</code></td><td><code>3</code></td><td> -</td></tr> -<tr><td><code>CREATED_TIME</code></td><td><code>4</code></td><td> -</td></tr> -<tr><td><code>UPDATED_TIME</code></td><td><code>5</code></td><td> -</td></tr> -</table></div> -<div class="definition"><h3 id="Enum_SearchCondition">Enumeration: SearchCondition</h3> -<p>Different search operators that can be used with the entity search fields</p> -<li>EQUAL : Simply matches for equality. Applicable for name, and parent entity id</li> -<li>LIKE : Check for the condition %$FIELD% condition. Applicable for name, and description</li> -<li>FULL_TEXT : Does a full text search. Only applicable for the FULL_TEXT field.</li> -<li>GTE : Greater than or equal. Only applicable for created time and updated time.</li> -<li>LTE : Less than or equal. Only applicable for created time and updated time.</li> - -<br/><br/><table class="table-bordered table-striped table-condensed"> -<tr><td><code>EQUAL</code></td><td><code>0</code></td><td> -</td></tr> -<tr><td><code>LIKE</code></td><td><code>1</code></td><td> -</td></tr> -<tr><td><code>FULL_TEXT</code></td><td><code>2</code></td><td> -</td></tr> -<tr><td><code>GTE</code></td><td><code>3</code></td><td> -</td></tr> -<tr><td><code>LTE</code></td><td><code>4</code></td><td> -</td></tr> -</table></div> -<div class="definition"><h3 id="Enum_SharingType">Enumeration: SharingType</h3> -<p>This is an internal enum type for managing sharings</p> - -<br/><br/><table class="table-bordered table-striped table-condensed"> -<tr><td><code>DIRECT_NON_CASCADING</code></td><td><code>0</code></td><td> -</td></tr> -<tr><td><code>DIRECT_CASCADING</code></td><td><code>1</code></td><td> -</td></tr> -<tr><td><code>INDIRECT_CASCADING</code></td><td><code>2</code></td><td> -</td></tr> -</table></div> -<hr/><h2 id="Structs">Data structures</h2> -<div class="definition"><h3 id="Struct_Domain">Struct: Domain</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>domainId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr> -<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>3</td><td>description</td><td><code>string</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> -</table><br/><p>Domain is the entity that enables multi-tenency in this componenet. Every tenant will be -operating separately it's own silo which is identified by the domain id. In the current implementation domain id -will be same as the domain name</p> -<li>domainId : Will be generated by the server based on the domain name</li> -<li><b>name</b> : A single word name that identifies the domain e.g seagrid, ultrascan</li> -<li>description : A short description for the domain</li> -<li>createdTime : Will be set by the system</li> -<li>updatedTime : Will be set by the system</li> - -<br/></div><div class="definition"><h3 id="Struct_User">Struct: User</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>userId</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>userName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>4</td><td>firstName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>5</td><td>lastName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>6</td><td>email</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>7</td><td>icon</td><td><code>binary</code></td><td></td><td>optional</td><td></td></tr> -<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 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>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> -<li><b>lastName</b> : Last name of the user</li> -<li><b>email</b> : Email address of the user</li> -<li>icon : A binary field for storing the user icon</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_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>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>ownerId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>6</td><td>groupType</td><td><code><a href="#Enum_GroupType">GroupType</a></code></td><td></td><td>optional</td><td></td></tr> -<tr><td>7</td><td>groupCardinality</td><td><code><a href="#Enum_GroupCardinality">GroupCardinality</a></code></td><td></td><td>optional</td><td></td></tr> -<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>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> - <li><b>ownerId</b> : Owner id of this group.</li> - <li><b>groupType</b> : Group type (DOMAIN_LEVEL_GROUP, USER_LEVEL_GROUP)</li> - <li><b>groupCardinality</b> : Group cardinality (SINGLE_USER, MULTI_USER)</li> - <li>createdTime : Will be set by the system</li> - <li>updatedTime : Will be set by the system</li> - -<br/></div><div class="definition"><h3 id="Struct_GroupMembership">Struct: GroupMembership</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>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> -</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>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>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> -<li>createdTime : Will be set by the system</li> -<li>updatedTime : Will be set by the system</li> - -<br/></div><div class="definition"><h3 id="Struct_SearchCriteria">Struct: SearchCriteria</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>searchField</td><td><code><a href="#Enum_EntitySearchField">EntitySearchField</a></code></td><td></td><td>optional</td><td></td></tr> -<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>3</td><td>searchCondition</td><td><code><a href="#Enum_SearchCondition">SearchCondition</a></code></td><td></td><td>optional</td><td></td></tr> -</table><br/><p>Container object for search criteria</p> -<li><b>searchField</b> : Entity search field</li> -<li><b>value</b> : Search value</li> -<li><b>searchCondition</b> : EQUAL, LIKE etc..</li> - -<br/></div><div class="definition"><h3 id="Struct_Entity">Struct: Entity</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>entityId</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>entityTypeId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<tr><td>4</td><td>ownerId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> -<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>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>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>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>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>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> -<li>createdTime : Will be set by the system</li> -<li>updatedTime : Will be set by the system</li> - -<br/></div><div class="definition"><h3 id="Struct_Sharing">Struct: Sharing</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></td></tr> -<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> -</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> -<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>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> -</table><br/><p>Exception model used in the sharing registry service</p> - -<br/></div></div></body></html> http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/api-docs/style.css ---------------------------------------------------------------------- diff --git a/modules/sharing-registry/api-docs/style.css b/modules/sharing-registry/api-docs/style.css deleted file mode 100644 index 34fd9d7..0000000 --- a/modules/sharing-registry/api-docs/style.css +++ /dev/null @@ -1,184 +0,0 @@ -/*! - * Bootstrap v2.0.3 - * - * Copyright 2012 Twitter, Inc - * Licensed under the Apache License v2.0 - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Designed and built with all the love in the world @twitter by @mdo and @fat. - */ -.clearfix{*zoom:1;}.clearfix:before,.clearfix:after{display:table;content:"";} -.clearfix:after{clear:both;} -.hide-text{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0;} -.input-block-level{display:block;width:100%;min-height:28px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;-ms-box-sizing:border-box;box-sizing:border-box;} -article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block;} -audio,canvas,video{display:inline-block;*display:inline;*zoom:1;} -audio:not([controls]){display:none;} -html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;} -a:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px;} -a:hover,a:active{outline:0;} -sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline;} -sup{top:-0.5em;} -sub{bottom:-0.25em;} -img{max-width:100%;vertical-align:middle;border:0;-ms-interpolation-mode:bicubic;} -button,input,select,textarea{margin:0;font-size:100%;vertical-align:middle;} -button,input{*overflow:visible;line-height:normal;} -button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0;} -button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;} -input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield;} -input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none;} -textarea{overflow:auto;vertical-align:top;} -body{margin:0;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px;line-height:18px;color:#333333;background-color:#ffffff;} -a{color:#0088cc;text-decoration:none;} -a:hover{color:#005580;text-decoration:underline;} -.row{margin-left:-20px;*zoom:1;}.row:before,.row:after{display:table;content:"";} -.row:after{clear:both;} -[class*="span"]{float:left;margin-left:20px;} -.container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:940px;} -.span12{width:940px;} -.span11{width:860px;} -.span10{width:780px;} -.span9{width:700px;} -.span8{width:620px;} -.span7{width:540px;} -.span6{width:460px;} -.span5{width:380px;} -.span4{width:300px;} -.span3{width:220px;} -.span2{width:140px;} -.span1{width:60px;} -.offset12{margin-left:980px;} -.offset11{margin-left:900px;} -.offset10{margin-left:820px;} -.offset9{margin-left:740px;} -.offset8{margin-left:660px;} -.offset7{margin-left:580px;} -.offset6{margin-left:500px;} -.offset5{margin-left:420px;} -.offset4{margin-left:340px;} -.offset3{margin-left:260px;} -.offset2{margin-left:180px;} -.offset1{margin-left:100px;} -.row-fluid{width:100%;*zoom:1;}.row-fluid:before,.row-fluid:after{display:table;content:"";} -.row-fluid:after{clear:both;} -.row-fluid [class*="span"]{display:block;width:100%;min-height:28px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;-ms-box-sizing:border-box;box-sizing:border-box;float:left;margin-left:2.127659574%;*margin-left:2.0744680846382977%;} -.row-fluid [class*="span"]:first-child{margin-left:0;} -.row-fluid .span12{width:99.99999998999999%;*width:99.94680850063828%;} -.row-fluid .span11{width:91.489361693%;*width:91.4361702036383%;} -.row-fluid .span10{width:82.97872339599999%;*width:82.92553190663828%;} -.row-fluid .span9{width:74.468085099%;*width:74.4148936096383%;} -.row-fluid .span8{width:65.95744680199999%;*width:65.90425531263828%;} -.row-fluid .span7{width:57.446808505%;*width:57.3936170156383%;} -.row-fluid .span6{width:48.93617020799999%;*width:48.88297871863829%;} -.row-fluid .span5{width:40.425531911%;*width:40.3723404216383%;} -.row-fluid .span4{width:31.914893614%;*width:31.8617021246383%;} -.row-fluid .span3{width:23.404255317%;*width:23.3510638276383%;} -.row-fluid .span2{width:14.89361702%;*width:14.8404255306383%;} -.row-fluid .span1{width:6.382978723%;*width:6.329787233638298%;} -.container{margin-right:auto;margin-left:auto;*zoom:1;}.container:before,.container:after{display:table;content:"";} -.container:after{clear:both;} -.container-fluid{padding-right:20px;padding-left:20px;*zoom:1;}.container-fluid:before,.container-fluid:after{display:table;content:"";} -.container-fluid:after{clear:both;} -p{margin:0 0 9px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px;line-height:18px;}p small{font-size:11px;color:#999999;} -.lead{margin-bottom:18px;font-size:20px;font-weight:200;line-height:27px;} -h1,h2,h3,h4,h5,h6{margin:0;font-family:inherit;font-weight:bold;color:inherit;text-rendering:optimizelegibility;}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small{font-weight:normal;color:#999999;} -h1{font-size:30px;line-height:36px;}h1 small{font-size:18px;} -h2{font-size:24px;line-height:36px;}h2 small{font-size:18px;} -h3{font-size:18px;line-height:27px;}h3 small{font-size:14px;} -h4,h5,h6{line-height:18px;} -h4{font-size:14px;}h4 small{font-size:12px;} -h5{font-size:12px;} -h6{font-size:11px;color:#999999;text-transform:uppercase;} -.page-header{padding-bottom:17px;margin:18px 0;border-bottom:1px solid #eeeeee;} -.page-header h1{line-height:1;} -ul,ol{padding:0;margin:0 0 9px 25px;} -ul ul,ul ol,ol ol,ol ul{margin-bottom:0;} -ul{list-style:disc;} -ol{list-style:decimal;} -li{line-height:18px;} -ul.unstyled,ol.unstyled{margin-left:0;list-style:none;} -dl{margin-bottom:18px;} -dt,dd{line-height:18px;} -dt{font-weight:bold;line-height:17px;} -dd{margin-left:9px;} -.dl-horizontal dt{float:left;width:120px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;} -.dl-horizontal dd{margin-left:130px;} -hr{margin:18px 0;border:0;border-top:1px solid #eeeeee;border-bottom:1px solid #ffffff;} -strong{font-weight:bold;} -em{font-style:italic;} -.muted{color:#999999;} -abbr[title]{cursor:help;border-bottom:1px dotted #ddd;} -abbr.initialism{font-size:90%;text-transform:uppercase;} -blockquote{padding:0 0 0 15px;margin:0 0 18px;border-left:5px solid #eeeeee;}blockquote p{margin-bottom:0;font-size:16px;font-weight:300;line-height:22.5px;} -blockquote small{display:block;line-height:18px;color:#999999;}blockquote small:before{content:'\2014 \00A0';} -blockquote.pull-right{float:right;padding-right:15px;padding-left:0;border-right:5px solid #eeeeee;border-left:0;}blockquote.pull-right p,blockquote.pull-right small{text-align:right;} -q:before,q:after,blockquote:before,blockquote:after{content:"";} -address{display:block;margin-bottom:18px;font-style:normal;line-height:18px;} -small{font-size:100%;} -cite{font-style:normal;} -code,pre{padding:0 3px 2px;font-family:Menlo,Monaco,Consolas,"Courier New",monospace;font-size:12px;color:#333333;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;} -code{padding:2px 4px;color:#d14;background-color:#f7f7f9;border:1px solid #e1e1e8;} -pre{display:block;padding:8.5px;margin:0 0 9px;font-size:12.025px;line-height:18px;word-break:break-all;word-wrap:break-word;white-space:pre;white-space:pre-wrap;background-color:#f5f5f5;border:1px solid #ccc;border:1px solid rgba(0, 0, 0, 0.15);-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;}pre.prettyprint{margin-bottom:18px;} -pre code{padding:0;color:inherit;background-color:transparent;border:0;} -.pre-scrollable{max-height:340px;overflow-y:scroll;} -.label,.badge{font-size:10.998px;font-weight:bold;line-height:14px;color:#ffffff;vertical-align:baseline;white-space:nowrap;text-shadow:0 -1px 0 rgba(0, 0, 0, 0.25);background-color:#999999;} -.label{padding:1px 4px 2px;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;} -.badge{padding:1px 9px 2px;-webkit-border-radius:9px;-moz-border-radius:9px;border-radius:9px;} -a.label:hover,a.badge:hover{color:#ffffff;text-decoration:none;cursor:pointer;} -.label-important,.badge-important{background-color:#b94a48;} -.label-important[href],.badge-important[href]{background-color:#953b39;} -.label-warning,.badge-warning{background-color:#f89406;} -.label-warning[href],.badge-warning[href]{background-color:#c67605;} -.label-success,.badge-success{background-color:#468847;} -.label-success[href],.badge-success[href]{background-color:#356635;} -.label-info,.badge-info{background-color:#3a87ad;} -.label-info[href],.badge-info[href]{background-color:#2d6987;} -.label-inverse,.badge-inverse{background-color:#333333;} -.label-inverse[href],.badge-inverse[href]{background-color:#1a1a1a;} -table{max-width:100%;background-color:transparent;border-collapse:collapse;border-spacing:0;} -.table{width:100%;margin-bottom:18px;}.table th,.table td{padding:8px;line-height:18px;text-align:left;vertical-align:top;border-top:1px solid #dddddd;} -.table th{font-weight:bold;} -.table thead th{vertical-align:bottom;} -.table caption+thead tr:first-child th,.table caption+thead tr:first-child td,.table colgroup+thead tr:first-child th,.table colgroup+thead tr:first-child td,.table thead:first-child tr:first-child th,.table thead:first-child tr:first-child td{border-top:0;} -.table tbody+tbody{border-top:2px solid #dddddd;} -.table-condensed th,.table-condensed td{padding:4px 5px;} -.table-bordered{border:1px solid #dddddd;border-collapse:separate;*border-collapse:collapsed;border-left:0;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;}.table-bordered th,.table-bordered td{border-left:1px solid #dddddd;} -.table-bordered caption+thead tr:first-child th,.table-bordered caption+tbody tr:first-child th,.table-bordered caption+tbody tr:first-child td,.table-bordered colgroup+thead tr:first-child th,.table-bordered colgroup+tbody tr:first-child th,.table-bordered colgroup+tbody tr:first-child td,.table-bordered thead:first-child tr:first-child th,.table-bordered tbody:first-child tr:first-child th,.table-bordered tbody:first-child tr:first-child td{border-top:0;} -.table-bordered thead:first-child tr:first-child th:first-child,.table-bordered tbody:first-child tr:first-child td:first-child{-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-topleft:4px;} -.table-bordered thead:first-child tr:first-child th:last-child,.table-bordered tbody:first-child tr:first-child td:last-child{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-moz-border-radius-topright:4px;} -.table-bordered thead:last-child tr:last-child th:first-child,.table-bordered tbody:last-child tr:last-child td:first-child{-webkit-border-radius:0 0 0 4px;-moz-border-radius:0 0 0 4px;border-radius:0 0 0 4px;-webkit-border-bottom-left-radius:4px;border-bottom-left-radius:4px;-moz-border-radius-bottomleft:4px;} -.table-bordered thead:last-child tr:last-child th:last-child,.table-bordered tbody:last-child tr:last-child td:last-child{-webkit-border-bottom-right-radius:4px;border-bottom-right-radius:4px;-moz-border-radius-bottomright:4px;} -.table-striped tbody tr:nth-child(odd) td,.table-striped tbody tr:nth-child(odd) th{background-color:#f9f9f9;} -.table tbody tr:hover td,.table tbody tr:hover th{background-color:#f5f5f5;} -table .span1{float:none;width:44px;margin-left:0;} -table .span2{float:none;width:124px;margin-left:0;} -table .span3{float:none;width:204px;margin-left:0;} -table .span4{float:none;width:284px;margin-left:0;} -table .span5{float:none;width:364px;margin-left:0;} -table .span6{float:none;width:444px;margin-left:0;} -table .span7{float:none;width:524px;margin-left:0;} -table .span8{float:none;width:604px;margin-left:0;} -table .span9{float:none;width:684px;margin-left:0;} -table .span10{float:none;width:764px;margin-left:0;} -table .span11{float:none;width:844px;margin-left:0;} -table .span12{float:none;width:924px;margin-left:0;} -table .span13{float:none;width:1004px;margin-left:0;} -table .span14{float:none;width:1084px;margin-left:0;} -table .span15{float:none;width:1164px;margin-left:0;} -table .span16{float:none;width:1244px;margin-left:0;} -table .span17{float:none;width:1324px;margin-left:0;} -table .span18{float:none;width:1404px;margin-left:0;} -table .span19{float:none;width:1484px;margin-left:0;} -table .span20{float:none;width:1564px;margin-left:0;} -table .span21{float:none;width:1644px;margin-left:0;} -table .span22{float:none;width:1724px;margin-left:0;} -table .span23{float:none;width:1804px;margin-left:0;} -table .span24{float:none;width:1884px;margin-left:0;} -/* Auto-generated CSS for generated Thrift docs */ -h3, h4 { margin-bottom: 6px; } -div.definition { border: 1px solid #CCC; margin-bottom: 10px; padding: 10px; } -div.extends { margin: -0.5em 0 1em 5em } -td { vertical-align: top; } -table { empty-cells: show; } -code { line-height: 20px; } -.table-bordered th, .table-bordered td { border-bottom: 1px solid #DDDDDD; } http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/sharing-registry-server/src/test/java/org/apache/airavata/sharing/registry/SharingRegistryServiceTest.java ---------------------------------------------------------------------- diff --git a/modules/sharing-registry/sharing-registry-server/src/test/java/org/apache/airavata/sharing/registry/SharingRegistryServiceTest.java b/modules/sharing-registry/sharing-registry-server/src/test/java/org/apache/airavata/sharing/registry/SharingRegistryServiceTest.java new file mode 100644 index 0000000..3357eb5 --- /dev/null +++ b/modules/sharing-registry/sharing-registry-server/src/test/java/org/apache/airavata/sharing/registry/SharingRegistryServiceTest.java @@ -0,0 +1,84 @@ +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + * +*/ +package org.apache.airavata.sharing.registry; + +import org.apache.airavata.sharing.registry.models.Domain; +import org.apache.airavata.sharing.registry.models.User; +import org.apache.airavata.sharing.registry.service.cpi.SharingRegistryService; +import org.apache.thrift.TException; +import org.apache.thrift.protocol.TBinaryProtocol; +import org.apache.thrift.protocol.TProtocol; +import org.apache.thrift.transport.TSocket; +import org.apache.thrift.transport.TTransport; +import org.junit.Ignore; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class SharingRegistryServiceTest { + private final static Logger logger = LoggerFactory.getLogger(SharingRegistryServiceTest.class); + + + @Test + @Ignore("Test is only for demonstration purposes") + public void test() throws TException { + String serverHost = "gw56.iu.xsede.org"; + int serverPort = 7878; + + TTransport transport = new TSocket(serverHost, serverPort); + transport.open(); + TProtocol protocol = new TBinaryProtocol(transport); + SharingRegistryService.Client sharingServiceClient = new SharingRegistryService.Client(protocol); + + Domain domain = new Domain(); + //has to be one word + domain.setName("test-domain"+System.currentTimeMillis()); + //optional + domain.setDescription("test domain description"); + + String domainId = sharingServiceClient.createDomain(domain); + + User user = new User(); + String userName = "test-user"; + String userId1 = userName + "@" + domainId; + //required + user.setUserId(userId1); + //required + user.setUserName(userName); + //required + user.setDomainId(domainId); + //required + user.setFirstName("John"); + //required + user.setLastName("Doe"); + //required + user.setEmail("john....@abc.com"); + //optional - this should be bytes of the users image icon + byte[] icon = new byte[10]; + user.setIcon(icon); + + //can be manually set. otherwise will be set to the current time by the system + user.setCreatedTime(System.currentTimeMillis()); + user.setUpdatedTime(System.currentTimeMillis()); + + sharingServiceClient.registerUser(user); + } +} \ No newline at end of file