guacamole-client/guacamole/src/main/webapp/app/rest/services/connectionGroupService.js

/*
 * Copyright (C) 2014 Glyptodon LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * Service for operating on connection groups via the REST API.
 */
angular.module('rest').factory('connectionGroupService', ['$http', 'authenticationService', 'ConnectionGroup',
        function connectionGroupService($http, authenticationService, ConnectionGroup) {
            
    var service = {};
    
    /**
     * Makes a request to the REST API to get the list of connection groups,
     * returning a promise that provides an array of
     * @link{ConnectionGroup} objects if successful.
     * 
     * @param {String} [parentID=ConnectionGroup.ROOT_IDENTIFIER]
     *     The ID of the connection group whose child connection groups should
     *     be returned. If not provided, the root connection group will be
     *     used by default.
     *                          
     * @returns {Promise.<ConnectionGroup[]>}
     *     A promise which will resolve with an array of @link{ConnectionGroup}
     *     objects upon success.
     */
    service.getConnectionGroups = function getConnectionGroups(parentID) {
        
        var parentIDParam = "";
        if (parentID)
            parentIDParam = "&parentID=" + parentID;
        
        return $http.get("api/connectionGroup?token=" + authenticationService.getCurrentToken() + parentIDParam);
    };
    
    /**
     * Makes a request to the REST API to get an individual connection group,
     * returning a promise that provides the corresponding
     * @link{ConnectionGroup} if successful.
     * 
     * @param {String} [connectionGroupID=ConnectionGroup.ROOT_IDENTIFIER]
     *     The ID of the connection group to retrieve. If not provided, the
     *     root connection group will be retrieved by default.
     *                          
     * @returns {Promise.<ConnectionGroup>} A promise for the HTTP call.
     *     A promise which will resolve with a @link{ConnectionGroup} upon
     *     success.
     */
    service.getConnectionGroup = function getConnectionGroup(connectionGroupID) {
        
        // Use the root connection group ID if no ID is passed in
        connectionGroupID = connectionGroupID || ConnectionGroup.ROOT_IDENTIFIER;
        
        return $http.get("api/connectionGroup/" + connectionGroupID + "?token=" + authenticationService.getCurrentToken());
    };
    
    /**
     * Makes a request to the REST API to save a connection group, returning a
     * promise that can be used for processing the results of the call. If the
     * connection group is new, and thus does not yet have an associated
     * identifier, the identifier will be automatically set in the provided
     * connection group upon success.
     * 
     * @param {ConnectionGroup} connectionGroup The connection group to update.
     *                          
     * @returns {Promise}
     *     A promise for the HTTP call which will succeed if and only if the
     *     save operation is successful.
     */
    service.saveConnectionGroup = function saveConnectionGroup(connectionGroup) {

        // If connection group is new, add it and set the identifier automatically
        if (!connectionGroup.identifier) {
            return $http.post("api/connectionGroup/?token=" + authenticationService.getCurrentToken(), connectionGroup).success(

                // Set the identifier on the new connection group
                function setConnectionGroupID(connectionGroupID){
                    connectionGroup.identifier = connectionGroupID;
                }

            );
        }

        // Otherwise, update the existing connection group
        else {
            return $http.post(
                "api/connectionGroup/" + connectionGroup.identifier + 
                "?token=" + authenticationService.getCurrentToken(), 
            connectionGroup);
        }

    };
    
    /**
     * FIXME: Why is this different from save?
     * 
     * Makes a request to the REST API to move a connection group to a
     * different group, returning a promise that can be used for processing the
     * results of the call.
     * 
     * @param {ConnectionGroup} connectionGroup The connection group to move. 
     *                          
     * @returns {Promise}
     *     A promise for the HTTP call which will succeed if and only if the
     *     move operation is successful.
     */
    service.moveConnectionGroup = function moveConnectionGroup(connectionGroup) {
        
        return $http.put(
            "api/connectionGroup/" + connectionGroup.identifier + 
            "?token=" + authenticationService.getCurrentToken() + 
            "&parentID=" + connectionGroup.parentIdentifier, 
        connectionGroup);
    };
    
    /**
     * Makes a request to the REST API to delete a connection group, returning
     * a promise that can be used for processing the results of the call.
     * 
     * @param {ConnectionGroup} connectionGroup The connection group to delete.
     *                          
     * @returns {Promise}
     *     A promise for the HTTP call which will succeed if and only if the
     *     delete operation is successful.
     */
    service.deleteConnectionGroup = function deleteConnectionGroup(connectionGroup) {
        return $http['delete'](
            "api/connectionGroup/" + connectionGroup.identifier + 
            "?token=" + authenticationService.getCurrentToken());
    };
    
    return service;
}]);