| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
|---|
| 2 | <!-- |
|---|
| 3 | $Id: sessionsettings.html 4509 2008-09-11 20:01:44Z jari $ |
|---|
| 4 | |
|---|
| 5 | Copyright (C) 2005 Jari Hakkinen, Nicklas Nordborg |
|---|
| 6 | Copyright (C) 2006 Jari Hakkinen |
|---|
| 7 | |
|---|
| 8 | This file is part of BASE - BioArray Software Environment. |
|---|
| 9 | Available at http://base.thep.lu.se/ |
|---|
| 10 | |
|---|
| 11 | BASE is free software; you can redistribute it and/or |
|---|
| 12 | modify it under the terms of the GNU General Public License |
|---|
| 13 | as published by the Free Software Foundation; either version 3 |
|---|
| 14 | of the License, or (at your option) any later version. |
|---|
| 15 | |
|---|
| 16 | BASE is distributed in the hope that it will be useful, |
|---|
| 17 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 19 | GNU General Public License for more details. |
|---|
| 20 | |
|---|
| 21 | You should have received a copy of the GNU General Public License |
|---|
| 22 | along with BASE. If not, see <http://www.gnu.org/licenses/>. |
|---|
| 23 | --> |
|---|
| 24 | <html> |
|---|
| 25 | <head> |
|---|
| 26 | <title>BASE - Core specification - Sessions and application settings</title> |
|---|
| 27 | <link rel=stylesheet type="text/css" href="../../styles.css"> |
|---|
| 28 | </head> |
|---|
| 29 | <body> |
|---|
| 30 | |
|---|
| 31 | <div class="navigation"> |
|---|
| 32 | <a href="../../index.html">BASE</a> |
|---|
| 33 | <img src="../../next.gif"> |
|---|
| 34 | <a href="index.html">Core specification</a> |
|---|
| 35 | <img src="../../next.gif"> |
|---|
| 36 | Session and application settings |
|---|
| 37 | </div> |
|---|
| 38 | |
|---|
| 39 | <h1>Sessions and application settings</h1> |
|---|
| 40 | |
|---|
| 41 | <div class="abstract"> |
|---|
| 42 | <p> |
|---|
| 43 | This document covers the details of how client applications should be able to store |
|---|
| 44 | configuration settings and temporary information in BASE. |
|---|
| 45 | </p> |
|---|
| 46 | |
|---|
| 47 | <b>Contents</b><br> |
|---|
| 48 | <ol> |
|---|
| 49 | <li><a href="#session">Sessions</a> |
|---|
| 50 | <li><a href="#settings">Settings</a> |
|---|
| 51 | </ol> |
|---|
| 52 | |
|---|
| 53 | <b>See also</b><br> |
|---|
| 54 | <ul> |
|---|
| 55 | <li><a href="../../development/overview/data/clients.html">Implementation overview</a> |
|---|
| 56 | </ul> |
|---|
| 57 | |
|---|
| 58 | <p class="authors"> |
|---|
| 59 | <b>Last updated:</b> $Date: 2008-09-11 20:01:44 +0000 (Thu, 11 Sep 2008) $ |
|---|
| 60 | </p> |
|---|
| 61 | </div> |
|---|
| 62 | |
|---|
| 63 | <a name="sessions"> |
|---|
| 64 | <h2>1. Sessions</h2> |
|---|
| 65 | </a> |
|---|
| 66 | |
|---|
| 67 | <ol> |
|---|
| 68 | <li>BASE should be able to handle multiple simultaneous logins, sessions, |
|---|
| 69 | to a single user account. One session must not interfere with another |
|---|
| 70 | one. |
|---|
| 71 | |
|---|
| 72 | <li class="client">[WEB CLIENT] The web client should be able to handle multiple logins |
|---|
| 73 | to the same account or to different accounts from the same browser on |
|---|
| 74 | a single workstation. |
|---|
| 75 | |
|---|
| 76 | </ol> |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | <a name="settings"> |
|---|
| 80 | <h2>2. Client application settings</h2> |
|---|
| 81 | </a> |
|---|
| 82 | |
|---|
| 83 | <ol> |
|---|
| 84 | <li>A client application should be able to store configuration settings |
|---|
| 85 | in BASE at three levels: |
|---|
| 86 | <ul> |
|---|
| 87 | <li>Session: the setting is only valid within the session. For example, |
|---|
| 88 | the sort order of a list of items. Once the session is finished all |
|---|
| 89 | session settings are lost. |
|---|
| 90 | |
|---|
| 91 | <li>User: the setting is valid for a specific user account. For example, |
|---|
| 92 | the font size on the web pages. |
|---|
| 93 | |
|---|
| 94 | <li>Default: the setting is valid for all user accounts that |
|---|
| 95 | doesn't override it with their own value. |
|---|
| 96 | </ul> |
|---|
| 97 | |
|---|
| 98 | <li>BASE may define settings that can be of general interest for several |
|---|
| 99 | client applications. The meaning and use of such settings should be |
|---|
| 100 | specified in some documentation. A client application may choose to ignore |
|---|
| 101 | those settings. <div class="note">[NOTE] We have decided to not specify |
|---|
| 102 | any settings of this type at the moment. However we reserve all names |
|---|
| 103 | starting with <code>global.</code> for future use for such settings.</div> |
|---|
| 104 | |
|---|
| 105 | <li>All settings are read from the database at login time, and are kept in |
|---|
| 106 | memory until the session is finished (ie. the user logs out). Settings |
|---|
| 107 | that have changed are then saved to the database. |
|---|
| 108 | |
|---|
| 109 | <li>A setting is a string value identified by a name, which is also a |
|---|
| 110 | string. The name must be unique for each type of setting. |
|---|
| 111 | <div class="question">[QUESTION] Or, should we use numeric keys and define constants in |
|---|
| 112 | the core and applications? |
|---|
| 113 | <br> |
|---|
| 114 | [ANSWER] No, it would only be cumbersome to handle. |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | <li class="question">[QUESTION] Do we need more powerful structures for storing settings? |
|---|
| 118 | <br> |
|---|
| 119 | [ANSWER] No, not at the moment. |
|---|
| 120 | |
|---|
| 121 | </ol> |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | </body> |
|---|
| 125 | </html> |
|---|
