MonoRail/Castle.MonoRail.Framework/Descriptors/ControllerDescriptor.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework.Descriptors
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Represents the configuration associated with a <see cref="IController"/>.
  21         /// </summary>
  22         public class ControllerDescriptor
  23         {
  24                 private readonly Type controllerType;
  25                 private readonly String name;
  26                 private readonly String area;
  27                 private readonly bool sessionless;
  28
  29                 /// <summary>
  30                 /// Initializes a new instance of the <see cref="ControllerDescriptor"/> class.
  31                 /// </summary>
  32                 /// <param name="controllerType">Type of the controller.</param>
  33                 /// <param name="name">The name of the controller.</param>
  34                 /// <param name="area">The area associated with the controller.</param>
  35                 /// <param name="sessionless">if set to <c>true</c> [sessionless].</param>
  36                 public ControllerDescriptor(Type controllerType, String name, String area, bool sessionless)
  37                 {
  38                         this.controllerType = controllerType;
  39                         this.name = name;
  40                         this.area = area;
  41                         this.sessionless = sessionless;
  42                 }
  43
  44                 /// <summary>
  45                 /// Gets the type of the controller.
  46                 /// </summary>
  47                 /// <value>The type of the controller.</value>
  48                 public Type ControllerType
  49                 {
  50                         get { return controllerType; }
  51                 }
  52
  53                 /// <summary>
  54                 /// Gets the controller's name.
  55                 /// </summary>
  56                 /// <value>The name.</value>
  57                 public String Name
  58                 {
  59                         get { return name; }
  60                 }
  61
  62                 /// <summary>
  63                 /// Gets the controller's area.
  64                 /// </summary>
  65                 /// <value>The area.</value>
  66                 public String Area
  67                 {
  68                         get { return area; }
  69                 }
  70
  71                 /// <summary>
  72                 /// Gets a value indicating whether the <see cref="IController"/> needs a session.
  73                 /// </summary>
  74                 /// <value><c>true</c> if sessionless; otherwise, <c>false</c>.</value>
  75                 public bool Sessionless
  76                 {
  77                         get { return sessionless; }
  78                 }
  79         }
  80 }