/*
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at <http://www.mozilla.org/MPL/>.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT
 * WARRANTY OF ANY KIND, either express or implied. See the License for the specific
 * language governing rights and limitations under the License.
 * 
 * The Original Code is the Venice Web Communities System.
 * 
 * The Initial Developer of the Original Code is Eric J. Bowersox <erbo@silcom.com>,
 * for Silverwrist Design Studios.  Portions created by Eric J. Bowersox are
 * Copyright (C) 2002-03 Eric J. Bowersox/Silverwrist Design Studios.  All Rights Reserved.
 * 
 * Contributor(s): 
 */
package com.silverwrist.dynamo.util;

import com.silverwrist.dynamo.iface.*;

/**
 * The default implementation of {@link com.silverwrist.dynamo.iface.SessionInfoProvider SessionInfoProvider}.
 * An instance of this object is created to "wrap" an instance of
 * {@link com.silverwrist.dynamo.iface.SessionInfo SessionInfo} and is then added to the request services when a
 * {@link com.silverwrist.dynamo.iface.Request Request} is created.
 *
 * @author Eric J. Bowersox &lt;erbo@silcom.com&gt;
 * @version X
 */
public class DefaultSessionInfoProvider implements SessionInfoProvider
{
  /*--------------------------------------------------------------------------------
   * Attributes
   *--------------------------------------------------------------------------------
   */

  private SessionInfo m_session;   // SessionInfo that we wrap

  /*--------------------------------------------------------------------------------
   * Constructor
   *--------------------------------------------------------------------------------
   */

  /**
   * Constructs a new <CODE>DefaultSessionInfoProvider</CODE>.
   *
   * @param session The instance of <CODE>SessionInfo</CODE> to be wrapped by this object.
   */
  public DefaultSessionInfoProvider(SessionInfo session)
  {
    m_session = session;

  } // end constructor

  /*--------------------------------------------------------------------------------
   * Implementations from interface SessionInfoProvider
   *--------------------------------------------------------------------------------
   */

  /**
   * Retrieves the current {@link com.silverwrist.dynamo.iface.SessionInfo SessionInfo} for this request.
   *
   * @return The current <CODE>SessionInfo</CODE> for this request.
   */
  public SessionInfo getSessionInfo()
  {
    return m_session;

  } // end getSessionInfo

} // end class DefaultSessionInfoProvider
