xenadmin/XenModel/Actions/DelegatedAsyncAction.cs

/* Copyright (c) Citrix Systems, Inc. 
 * All rights reserved. 
 * 
 * Redistribution and use in source and binary forms, 
 * with or without modification, are permitted provided 
 * that the following conditions are met: 
 * 
 * *   Redistributions of source code must retain the above 
 *     copyright notice, this list of conditions and the 
 *     following disclaimer. 
 * *   Redistributions in binary form must reproduce the above 
 *     copyright notice, this list of conditions and the 
 *     following disclaimer in the documentation and/or other 
 *     materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
 * SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using System.Text;

using XenAdmin.Core;
using XenAdmin.Network;
using XenAPI;

namespace XenAdmin.Actions
{
    /// <summary>
    /// An action which just runs a delegate.
    /// It is bad style to use this for more than the very simplest delegate: preferably just a single API call.
    /// Anything more complicated should be turned into a proper action of its own.
    /// </summary>
    public class DelegatedAsyncAction : AsyncAction
    {
        private readonly Action<Session> invoker;
        private readonly string endDescription;

        public DelegatedAsyncAction(IXenConnection connection, string title, string startDescription, string endDescription,
            Action<Session> invoker, params string[] rbacMethods)
            : this(connection, title, startDescription, endDescription, invoker, false, rbacMethods)
        {
        }

        public DelegatedAsyncAction(IXenConnection connection, string title, string startDescription, string endDescription,
            Action<Session> invoker, bool suppressHistory, params string[] rbacMethods)
            : base(connection, title, startDescription, suppressHistory)
        {
            this.endDescription = endDescription;
            this.invoker = invoker;
            ApiMethodsToRoleCheck = new RbacMethodList(rbacMethods);
        }

        protected override void Run()
        {
            invoker(Session);
            Description = endDescription;
        }
    }
}