aspnetcore/src/Microsoft.AspNetCore.Mvc.Core/ControllerContext.cs

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Mvc.Core;
using Microsoft.AspNetCore.Mvc.Formatters;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Mvc.ModelBinding.Validation;

namespace Microsoft.AspNetCore.Mvc
{
    /// <summary>
    /// The context associated with the current request for a controller.
    /// </summary>
    public class ControllerContext : ActionContext
    {
        private FormatterCollection<IInputFormatter> _inputFormatters;
        private IList<IModelBinder> _modelBinders;
        private IList<IModelValidatorProvider> _validatorProviders;
        private IList<IValueProvider> _valueProviders;

        /// <summary>
        /// Creates a new <see cref="ControllerContext"/>.
        /// </summary>
        /// <remarks>
        /// The default constructor is provided for unit test purposes only.
        /// </remarks>
        public ControllerContext()
            : base()
        {
        }

        /// <summary>
        /// Creates a new <see cref="ControllerContext"/>.
        /// </summary>
        /// <param name="context">The <see cref="ActionContext"/> associated with the current request.</param>
        public ControllerContext(ActionContext context)
            : base(context)
        {
            if (!(context.ActionDescriptor is ControllerActionDescriptor))
            {
                throw new ArgumentException(Resources.FormatActionDescriptorMustBeBasedOnControllerAction(
                    typeof(ControllerActionDescriptor)),
                    nameof(context));
            }
        }

        /// <summary>
        /// Gets or sets the <see cref="ControllerActionDescriptor"/> associated with the current request.
        /// </summary>
        public new ControllerActionDescriptor ActionDescriptor
        {
            get { return (ControllerActionDescriptor)base.ActionDescriptor; }
            set { base.ActionDescriptor = value; }
        }

        /// <summary>
        /// Gets or sets the list of <see cref="IInputFormatter"/> instances for the current request.
        /// </summary>
        public virtual FormatterCollection<IInputFormatter> InputFormatters
        {
            get
            {
                if (_inputFormatters == null)
                {
                    _inputFormatters = new FormatterCollection<IInputFormatter>();
                }

                return _inputFormatters;
            }
            set
            {
                if (value == null)
                {
                    throw new ArgumentNullException(nameof(value));
                }

                _inputFormatters = value;
            }
        }

        /// <summary>
        /// Gets or sets the list of <see cref="IModelBinder"/> instances for the current request.
        /// </summary>
        public virtual IList<IModelBinder> ModelBinders
        {
            get
            {
                if (_modelBinders == null)
                {
                    _modelBinders = new List<IModelBinder>();
                }

                return _modelBinders;
            }
            set
            {
                if (value == null)
                {
                    throw new ArgumentNullException(nameof(value));
                }

                _modelBinders = value;
            }
        }

        /// <summary>
        /// Gets or sets the list of <see cref="IModelValidatorProvider"/> instances for the current request.
        /// </summary>
        public virtual IList<IModelValidatorProvider> ValidatorProviders
        {
            get
            {
                if (_validatorProviders == null)
                {
                    _validatorProviders = new List<IModelValidatorProvider>();
                }

                return _validatorProviders;
            }
            set
            {
                if (value == null)
                {
                    throw new ArgumentNullException(nameof(value));
                }

                _validatorProviders = value;
            }
        }

        /// <summary>
        /// Gets or sets the list of <see cref="IValueProvider"/> instances for the current request.
        /// </summary>
        public virtual IList<IValueProvider> ValueProviders
        {
            get
            {
                if (_valueProviders == null)
                {
                    _valueProviders = new List<IValueProvider>();
                }

                return _valueProviders;
            }
            set
            {
                if (value == null)
                {
                    throw new ArgumentNullException(nameof(value));
                }

                _valueProviders = value;
            }
        }
    }
}