From 909fb4ebd9a30deab30b8f71d95a000a311211be Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 7 Aug 2016 19:25:23 -0700 Subject: [PATCH] GUACAMOLE-5: Implement JavaScript service for accessing the sharing profile REST resource. --- .../rest/services/sharingProfileService.js | 183 ++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 guacamole/src/main/webapp/app/rest/services/sharingProfileService.js diff --git a/guacamole/src/main/webapp/app/rest/services/sharingProfileService.js b/guacamole/src/main/webapp/app/rest/services/sharingProfileService.js new file mode 100644 index 000000000..304dbe569 --- /dev/null +++ b/guacamole/src/main/webapp/app/rest/services/sharingProfileService.js @@ -0,0 +1,183 @@ +/* + * 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. + */ + +/** + * Service for operating on sharing profiles via the REST API. + */ +angular.module('rest').factory('sharingProfileService', ['$injector', + function sharingProfileService($injector) { + + // Required services + var $http = $injector.get('$http'); + var authenticationService = $injector.get('authenticationService'); + var cacheService = $injector.get('cacheService'); + + var service = {}; + + /** + * Makes a request to the REST API to get a single sharing profile, + * returning a promise that provides the corresponding @link{SharingProfile} + * if successful. + * + * @param {String} id The ID of the sharing profile. + * + * @returns {Promise.} + * A promise which will resolve with a @link{SharingProfile} upon + * success. + * + * @example + * + * sharingProfileService.getSharingProfile('mySharingProfile').success(function(sharingProfile) { + * // Do something with the sharing profile + * }); + */ + service.getSharingProfile = function getSharingProfile(dataSource, id) { + + // Build HTTP parameters set + var httpParameters = { + token : authenticationService.getCurrentToken() + }; + + // Retrieve sharing profile + return $http({ + cache : cacheService.connections, + method : 'GET', + url : 'api/session/data/' + encodeURIComponent(dataSource) + '/sharingProfiles/' + encodeURIComponent(id), + params : httpParameters + }); + + }; + + /** + * Makes a request to the REST API to get the parameters of a single + * sharing profile, returning a promise that provides the corresponding + * map of parameter name/value pairs if successful. + * + * @param {String} id + * The identifier of the sharing profile. + * + * @returns {Promise.>} + * A promise which will resolve with an map of parameter name/value + * pairs upon success. + */ + service.getSharingProfileParameters = function getSharingProfileParameters(dataSource, id) { + + // Build HTTP parameters set + var httpParameters = { + token : authenticationService.getCurrentToken() + }; + + // Retrieve sharing profile parameters + return $http({ + cache : cacheService.connections, + method : 'GET', + url : 'api/session/data/' + encodeURIComponent(dataSource) + '/sharingProfiles/' + encodeURIComponent(id) + '/parameters', + params : httpParameters + }); + + }; + + /** + * Makes a request to the REST API to save a sharing profile, returning a + * promise that can be used for processing the results of the call. If the + * sharing profile is new, and thus does not yet have an associate + * identifier, the identifier will be automatically set in the provided + * sharing profile upon success. + * + * @param {SharingProfile} sharingProfile + * The sharing profile to update. + * + * @returns {Promise} + * A promise for the HTTP call which will succeed if and only if the + * save operation is successful. + */ + service.saveSharingProfile = function saveSharingProfile(dataSource, sharingProfile) { + + // Build HTTP parameters set + var httpParameters = { + token : authenticationService.getCurrentToken() + }; + + // If sharing profile is new, add it and set the identifier automatically + if (!sharingProfile.identifier) { + return $http({ + method : 'POST', + url : 'api/session/data/' + encodeURIComponent(dataSource) + '/sharingProfiles', + params : httpParameters, + data : sharingProfile + }) + + // Set the identifier on the new sharing profile and clear the cache + .success(function sharingProfileCreated(newSharingProfile){ + sharingProfile.identifier = newSharingProfile.identifier; + cacheService.connections.removeAll(); + }); + } + + // Otherwise, update the existing sharing profile + else { + return $http({ + method : 'PUT', + url : 'api/session/data/' + encodeURIComponent(dataSource) + '/sharingProfiles/' + encodeURIComponent(sharingProfile.identifier), + params : httpParameters, + data : sharingProfile + }) + + // Clear the cache + .success(function sharingProfileUpdated(){ + cacheService.connections.removeAll(); + }); + } + + }; + + /** + * Makes a request to the REST API to delete a sharing profile, + * returning a promise that can be used for processing the results of the call. + * + * @param {SharingProfile} sharingProfile + * The sharing profile to delete. + * + * @returns {Promise} + * A promise for the HTTP call which will succeed if and only if the + * delete operation is successful. + */ + service.deleteSharingProfile = function deleteSharingProfile(dataSource, sharingProfile) { + + // Build HTTP parameters set + var httpParameters = { + token : authenticationService.getCurrentToken() + }; + + // Delete sharing profile + return $http({ + method : 'DELETE', + url : 'api/session/data/' + encodeURIComponent(dataSource) + '/sharingProfiles/' + encodeURIComponent(sharingProfile.identifier), + params : httpParameters + }) + + // Clear the cache + .success(function sharingProfileDeleted(){ + cacheService.connections.removeAll(); + }); + + }; + + return service; +}]);