KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > portal > generic > SessionPreferencesStore


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution, if
19  * any, must include the following acknowlegement:
20  * "This product includes software developed by the
21  * Caucho Technology (http://www.caucho.com/)."
22  * Alternately, this acknowlegement may appear in the software itself,
23  * if and wherever such third-party acknowlegements normally appear.
24  *
25  * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * info@caucho.com.
29  *
30  * 5. Products derived from this software may not be called "Resin"
31  * nor may "Resin" appear in their names without prior written
32  * permission of Caucho Technology.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  * @author Sam
47  */
48
49 package com.caucho.portal.generic;
50
51 import javax.portlet.PortletRequest;
52 import javax.portlet.PortletSession;
53 import java.util.Map JavaDoc;
54
55 /**
56  * SessionPreferencesFactory creates or returns an existing store that is in
57  * the users's session.
58  *
59  * Each namespace is assigned an attribute name to use in the session,
60  * the attribute value is an instance of {@link SessionPreferences}.
61  */
62 public class SessionPreferencesStore
63   implements PreferencesStore
64 {
65   /** Attribute name to use in session */
66   private final static String JavaDoc SESSION_PREFERENCES
67     = "com.caucho.portal.generic.SessionPreferences";
68
69   private boolean _alwaysCreateSession = true;
70
71   /**
72    * If true then a session is always created for the user if there is not one
73    * already, default is true.
74    */
75   public void setAlwaysCreateSession(boolean alwaysCreateSession)
76   {
77     _alwaysCreateSession = alwaysCreateSession;
78   }
79
80   public Map JavaDoc<String JavaDoc, String JavaDoc[]> getPreferencesMap( PortletRequest request,
81                                                   String JavaDoc namespace )
82   {
83     SessionPreferences pref = null;
84
85     PortletSession session = request.getPortletSession(_alwaysCreateSession);
86
87     if (session != null) {
88       // If the user has a session, create or reuse a
89 // SessionPreferences that is stored in the session.
90
91       String JavaDoc attributeName = SESSION_PREFERENCES;
92
93       if (namespace.length() > 0) {
94         int len = SESSION_PREFERENCES.length() + namespace.length() + 2;
95         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(len);
96         buf.append(SESSION_PREFERENCES);
97         buf.append('.');
98         buf.append(namespace);
99         attributeName = buf.toString();
100       }
101
102       synchronized (session) {
103         pref = (SessionPreferences) session.getAttribute(attributeName);
104
105         if (pref == null) {
106           pref = new SessionPreferences();
107           session.setAttribute(attributeName, pref);
108         }
109       }
110     }
111
112     return pref;
113   }
114
115   public void finish(Map JavaDoc<String JavaDoc, String JavaDoc[]> preferences)
116   {
117     SessionPreferences pref = (SessionPreferences) preferences;
118     pref.updateSessionIfNeeded();
119   }
120 }
121
122
Popular Tags