class/System.Web.Mvc/System.Web.Mvc/ControllerBase.cs

   1 /* ****************************************************************************
   2  *
   3  * Copyright (c) Microsoft Corporation. All rights reserved.
   4  *
   5  * This software is subject to the Microsoft Public License (Ms-PL).
   6  * A copy of the license can be found in the license.htm file included
   7  * in this distribution.
   8  *
   9  * You must not remove this notice, or any other, from this software.
  10  *
  11  * ***************************************************************************/
  12
  13 namespace System.Web.Mvc {
  14     using System;
  15     using System.Collections.Generic;
  16     using System.Diagnostics.CodeAnalysis;
  17     using System.Web.Routing;
  18
  19     public abstract class ControllerBase : MarshalByRefObject, IController {
  20
  21         private TempDataDictionary _tempDataDictionary;
  22         private bool _validateRequest = true;
  23         private IDictionary<string, ValueProviderResult> _valueProvider;
  24         private ViewDataDictionary _viewDataDictionary;
  25
  26         public ControllerContext ControllerContext {
  27             get;
  28             set;
  29         }
  30
  31         [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly",
  32             Justification = "This property is settable so that unit tests can provide mock implementations.")]
  33         public TempDataDictionary TempData {
  34             get {
  35                 if (_tempDataDictionary == null) {
  36                     _tempDataDictionary = new TempDataDictionary();
  37                 }
  38                 return _tempDataDictionary;
  39             }
  40             set {
  41                 _tempDataDictionary = value;
  42             }
  43         }
  44
  45         public bool ValidateRequest {
  46             get {
  47                 return _validateRequest;
  48             }
  49             set {
  50                 _validateRequest = value;
  51             }
  52         }
  53
  54         [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly",
  55             Justification = "This property is settable so that unit tests can provide mock implementations.")]
  56         public IDictionary<string, ValueProviderResult> ValueProvider {
  57             get {
  58                 if (_valueProvider == null) {
  59                     _valueProvider = new ValueProviderDictionary(ControllerContext);
  60                 }
  61                 return _valueProvider;
  62             }
  63             set {
  64                 _valueProvider = value;
  65             }
  66         }
  67
  68         [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly",
  69             Justification = "This property is settable so that unit tests can provide mock implementations.")]
  70         public ViewDataDictionary ViewData {
  71             get {
  72                 if (_viewDataDictionary == null) {
  73                     _viewDataDictionary = new ViewDataDictionary();
  74                 }
  75                 return _viewDataDictionary;
  76             }
  77             set {
  78                 _viewDataDictionary = value;
  79             }
  80         }
  81
  82         protected virtual void Execute(RequestContext requestContext) {
  83             if (requestContext == null) {
  84                 throw new ArgumentNullException("requestContext");
  85             }
  86
  87             Initialize(requestContext);
  88             ExecuteCore();
  89         }
  90
  91         protected abstract void ExecuteCore();
  92
  93         protected virtual void Initialize(RequestContext requestContext) {
  94             ControllerContext = new ControllerContext(requestContext, this);
  95         }
  96
  97         #region IController Members
  98         void IController.Execute(RequestContext requestContext) {
  99             Execute(requestContext);
 100         }
 101         #endregion
 102     }
 103 }