MonoRail/Castle.MonoRail.Framework/Extensions/Session/ICustomSessionFactory.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.Extensions.Session
  16 {
  17         using System.Collections;
  18
  19         /// <summary>
  20         /// Contract used by <see cref="CustomSessionExtension"/>
  21         /// to obtain the session implementation provided by the programmer
  22         /// </summary>
  23         public interface ICustomSessionFactory
  24         {
  25                 /// <summary>
  26                 /// Should identify the session using the context (usually a cookie is used
  27                 /// for that)
  28                 /// </summary>
  29                 /// <param name="context"></param>
  30                 /// <returns></returns>
  31                 IDictionary ObtainSession(IEngineContext context);
  32
  33                 /// <summary>
  34                 /// Should persist the session state associated with the context (again, a cookie
  35                 /// is the standard approach to identify the session)
  36                 /// </summary>
  37                 /// <param name="session"></param>
  38                 /// <param name="context"></param>
  39                 void PersistSession(IDictionary session, IEngineContext context);
  40         }
  41 }