// Copyright 2005-2010 Gallio Project - http://www.gallio.org/
// Portions Copyright 2000-2004 Jonathan de Halleux
// 
// Licensed 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.

using System;
using System.Collections.Generic;
using System.Text;
using Gallio.Runtime.ProgressMonitoring;

namespace Gallio.Runtime.Security
{
    /// <summary>
    /// Provides a context within which commands may be executed with elevated privileges.
    /// </summary>
    public interface IElevationContext
    {
        /// <summary>
        /// Executes an elevated command.
        /// </summary>
        /// <param name="elevatedCommandId">The command id.</param>
        /// <param name="arguments">The command arguments, must be null or serializable.</param>
        /// <param name="progressMonitor">The progress monitor.</param>
        /// <returns>The command result.</returns>
        /// <exception cref="ArgumentNullException">Thrown if <paramref name="elevatedCommandId"/>
        /// or <paramref name="progressMonitor"/> is null.</exception>
        object Execute(string elevatedCommandId, object arguments, IProgressMonitor progressMonitor);
    }
}
