<?xml version="1.0"?>
<!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
-->

<document>

 <properties>
  <title>Turbine Services - Session Service</title>
 </properties>

<body>

<section name="Overview">

<p>
    The Session Service was created to allow Turbine based applications
    to access information about the current sessions in the
    application's context.  Some of the most obvious uses would include
    <ul>
        <li>Count of the active sessions</li>
        <li>Determine if a given user is already logged in on another
            session
        </li>
        <li>Terminate a session</li>
    </ul>
</p>

<p>
    The service is implemented by using a listener configured in
    your application's deployment descriptor.  The listener class
    is used by the container to notify the service when sessions
    are created or destroyed.
</p>

</section>

<section name="Configuration">

<p>
    You will need to modify a few files in order to activate the service.
    The first modification will be in your TurbineResources.properties.
    See the example below for two settings that need to be present in
    order for the service to work.
</p>

<source><![CDATA[
# -------------------------------------------------------------------
#
#  S E R V I C E S
#
# -------------------------------------------------------------------
# Classes for Turbine Services should be defined here.
# Format: services.[name].classname=[implementing class]
#
# To specify properties of a service use the following syntax:
# service.[name].[property]=[value]

services.SessionService.classname=org.apache.turbine.services.session.TurbineSessionService
.
.
.
# -------------------------------------------------------------------
#
#  S E S S I O N  S E R V I C E
#
# -------------------------------------------------------------------

services.SessionService.earlyInit=true

]]></source>

<p>
    The next modification will be your application's deployment
    descriptor (web.xml).  Here we will configure the listener class.
</p>

<source><![CDATA[
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>

    <listener>
        <listener-class>org.apache.turbine.services.session.SessionListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>MyServletName</servlet-name>
        <servlet-class>org.apache.turbine.Turbine</servlet-class>
        <init-param>
            <param-name>properties</param-name>
            <param-value>/WEB-INF/conf/TurbineResources.properties</param-value>
        </init-param>
    </servlet>

</web-app>
]]></source>

<p>
    There is also a pull tool avilable for accessing this service.  To make it
    available for use in your velocity templates, add the following line to
    your TR.props file.
</p>
<source><![CDATA[
tool.session.sessionmgt = org.apache.turbine.services.session.SessionTool
]]></source>

</section>

<section name="Usage">

<p>
    The Session Service should be accessed through the
    <code>org.apache.turbine.services.session.TurbineSession</code> class or the
    pull tool.  See the javadocs for both classes for more usage information.
</p>

</section>

</body>
</document>
