MonoRail/Castle.MonoRail.Framework/IControllerFactory.cs

   1 // Copyright 2004-2007 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         /// <summary>
  18         /// Depicts the contract the engine has
  19         /// to perform the creation and disposal of
  20         /// <see cref="Controller"/> instances.
  21         /// </summary>
  22         public interface IControllerFactory
  23         {
  24                 /// <summary>
  25                 /// Implementors should perform their logic to
  26                 /// return a instance of <see cref="Controller"/>.
  27                 /// If the <see cref="Controller"/> can not be found,
  28                 /// it should return <c>null</c>.
  29                 /// </summary>
  30                 /// <param name="urlInfo"></param>
  31                 /// <returns></returns>
  32                 Controller CreateController(UrlInfo urlInfo);
  33
  34                 /// <summary>
  35                 /// Implementors should perform their logic
  36                 /// to release the <see cref="Controller"/> instance
  37                 /// and its resources.
  38                 /// </summary>
  39                 /// <param name="controller"></param>
  40                 void Release(Controller controller);
  41         }
  42 }