README
1
2Apache::SessionX - An extented persistence framework for session data
3----------------------------------------------------------------------
4
5Copyright (c) 1997-2001 Gerald Richter / ecos gmbh
6
7You may distribute under the terms of either the GNU General Public
8License or the Artistic License, as specified in the Perl README file.
9
10THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
11WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
12MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
13
14$Id: README,v 1.2 2001/08/14 04:37:28 richter Exp $
15
16
17OVERVIEW
18========
19
20Apache::SessionX extents Apache::Session. It was initialy written to
21use Apache::Session from inside of HTML::Embperl, but is seems to be
22usefull outside of Embperl as well, so here is it as standalone module.
23
24Apache::Session is a persistence framework which is particularly useful
25for tracking session data between httpd requests. Apache::Session is
26designed to work with Apache and mod_perl, but it should work under
27CGI and other web servers, and it also works outside of a web server
28altogether.
29
30Addtionaly to Apache::Session, Apache::SessionX provides the following
31possibilites:
32
33- Configuration: Makefile.PL checks which componemnts are installed
34 on the system and interactivly builds a set of configuration,
35 including a default one. This configurations are saved and can
36 be used by name later on. The default configuration is used, if
37 no parameters are given to Apache::SessionX. This simplifies
38 the configuration and usage.
39
40- Lazy operation: Apache::SessionX supports lazy operation, that means
41 that the actual data access only takes place if the session data is
42 needed, so you are able to setup the session object, without worrying
43 about performance in case you don't access the session data.
44
45- Specifing the ID: Apache::SessionX can use a given ID instead of
46 creating it's own one. You can also give an string which is used to
47 generate the ID
48
49- Genrate unique ID: Apache::SessionX is able to save the session with
50 an new ID every time data is modified. This make it possible to keep
51 an history.
52
53- Addtionaly methods are provided to get the ID, the inital ID, the
54 modified status and to close a session, without destroying the
55 session object itself.
56
57
58DOCUMENTATION
59=============
60
61After Installation the documentaion could be viewed via
62
63 perldoc Apache::SessionX
64
65You should addtionaly read the
66
67 perldoc Apache::SessionX
68 perldoc Apache::SessionX::Generate::MD5
69 perldoc Apache::Session::Store::*
70 perldoc Apache::Session::Lock::*
71 perldoc Apache::Session::Serialize::*
72
73
74INSTALLATION
75============
76
77perl Makefile.PL
78make
79make test
80make install
81
82Makefile.PL will ask you what configuration you want to use and saves
83them for later use with the config parameter. This configuration are
84tested when you run make test, so it's really a good idea to run
85make test, to make sure everything works as expected. Even better is
86to run make test as the user, that your webserver is running as, so
87you are able to detected permission problems early.
88
89
90SUPPORT
91=======
92
93You can get support for this module via the mod_perl or Embperl
94mailing list. Please use the lists for any questions and don't
95contact me directly. Details about the list can be found at
96
97 http://perl.apache.org/
98
99
100AUTHOR
101======
102
103G. Richter (richter@dev.ecos.de)
104
105
106
107