MonoRail/Castle.MonoRail.Framework/Services/IControllerFactory.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
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Depicts the contract the engine has
  21         /// to perform the creation and disposal of
  22         /// <see cref="IController"/> instances.
  23         /// </summary>
  24         public interface IControllerFactory
  25         {
  26                 /// <summary>
  27                 /// Implementors should perform their logic to
  28                 /// return a instance of <see cref="IController"/>.
  29                 /// If the <see cref="IController"/> can not be found,
  30                 /// it should return <c>null</c>.
  31                 /// </summary>
  32                 /// <param name="area">The area.</param>
  33                 /// <param name="controller">The controller.</param>
  34                 /// <returns></returns>
  35                 IController CreateController(string area, string controller);
  36
  37                 /// <summary>
  38                 /// Creates the controller.
  39                 /// </summary>
  40                 /// <param name="controllerType">Type of the controller.</param>
  41                 /// <returns></returns>
  42                 IController CreateController(Type controllerType);
  43
  44                 /// <summary>
  45                 /// Implementors should perform their logic
  46                 /// to release the <see cref="IController"/> instance
  47                 /// and its resources.
  48                 /// </summary>
  49                 /// <param name="controller"></param>
  50                 void Release(IController controller);
  51         }
  52 }