genSpace Web Services
The core functionalities of genSpace web services can be categorized into 7 facades in the following:
- UserFacade: Retrieve corresponding information about the current user in genSpace. The selected web methods are listed as following:
- getProfile: Retrieve the profile of current user
- updateUser: Update the information, such as password, for current user
- getMyNetworks: Retrieve all networks that the current user is in
- UsageInformation: Retrieve information about tools and workflows of geWorkbench. The selected web methods are listed as following:
- getTool: Retrieve the corresponding tool by too ID
- getWorkflow: Retrieve the corresponding workflow by workflow ID
- getMyNotes: Retrieve the note from user for a specific analysis event. An analysis event includes an invocation of geWorkbench tool
- saveNote: Save the public note from user for a specific analysis event. This note can be seen by user and user’s friends
- savePriv_Note: Save the private note from user for a specific analysis event. This note can be seen by user only
- ToolUsageInformation: Retrieve statistic data about tools and workflows of geWorkbench. The selected web methods are listed as following:
- getToolsByPopularity: Retrieve the data of using times for each tool in geWorkbench
- getWorkflowsByPopularity: Retrieve the data of using times for each work flow in geWorkbench
- getToolSuggestion: Retrieve the suggestion for next tool based on current tool
- sendUsageEvent: Store the logged analysis event from geWorkbench in genSpace
- FriendFacade: Retrieve information about friends of current user in genSpace. The selected web methods are listed as following:
- getFriendRequest: Inform user that a new friend in genSpace who sends a friend-invitation
- addFriend: Accept friend-invitation from a new friend
- getFriends: Retrieve all users who are friends of user in genSpace
- getMyFriendsEvents: Retrieve the analysis events from friends of user in genSpace
- PublicFacade: Responsible to register new users. The selected web methods are listed as following:
- register: Register new users for genSpace. This method is now synchronized with the registration function in geWorkbench. When a new user registers in geWorkbench, she/he will also be registered in genSpace immediately
- userExists: A guarding method to check if the registered username has been used by a former user
- NetworkFacade: Retrieve information about corresponding networks of user in genSpace. the selected web methods are listed as following:
- createNetwork: Allow user to create a new network in genSpace
- joinNetwork: Allow user to request joining an existing network in genSpace
- leaveNetwork: Allow user to leave a network
- WorkflowRepository: A managing facade for users to store workflows created by them or their friends in geWorkbench
- addWorkflow: Add a new workflow in the workflow repository
- addComment: Add comment to a specific workflow in the workflow repository
- sendWorkflow: Send an existing workflow in the workflow repository to friends