001: /*
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution, if
019: * any, must include the following acknowlegement:
020: * "This product includes software developed by the
021: * Caucho Technology (http://www.caucho.com/)."
022: * Alternately, this acknowlegement may appear in the software itself,
023: * if and wherever such third-party acknowlegements normally appear.
024: *
025: * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
026: * endorse or promote products derived from this software without prior
027: * written permission. For written permission, please contact
028: * info@caucho.com.
029: *
030: * 5. Products derived from this software may not be called "Resin"
031: * nor may "Resin" appear in their names without prior written
032: * permission of Caucho Technology.
033: *
034: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
035: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
036: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
037: * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
038: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
039: * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
040: * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
041: * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
042: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
043: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
044: * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
045: *
046: * @author Sam
047: */
048:
049: package com.caucho.portal.generic;
050:
051: import javax.portlet.PortletRequest;
052: import javax.portlet.PortletSession;
053: import java.util.Map;
054:
055: /**
056: * SessionPreferencesFactory creates or returns an existing store that is in
057: * the users's session.
058: *
059: * Each namespace is assigned an attribute name to use in the session,
060: * the attribute value is an instance of {@link SessionPreferences}.
061: */
062: public class SessionPreferencesStore implements PreferencesStore {
063: /** Attribute name to use in session */
064: private final static String SESSION_PREFERENCES = "com.caucho.portal.generic.SessionPreferences";
065:
066: private boolean _alwaysCreateSession = true;
067:
068: /**
069: * If true then a session is always created for the user if there is not one
070: * already, default is true.
071: */
072: public void setAlwaysCreateSession(boolean alwaysCreateSession) {
073: _alwaysCreateSession = alwaysCreateSession;
074: }
075:
076: public Map<String, String[]> getPreferencesMap(
077: PortletRequest request, String namespace) {
078: SessionPreferences pref = null;
079:
080: PortletSession session = request
081: .getPortletSession(_alwaysCreateSession);
082:
083: if (session != null) {
084: // If the user has a session, create or reuse a
085: // SessionPreferences that is stored in the session.
086:
087: String attributeName = SESSION_PREFERENCES;
088:
089: if (namespace.length() > 0) {
090: int len = SESSION_PREFERENCES.length()
091: + namespace.length() + 2;
092: StringBuffer buf = new StringBuffer(len);
093: buf.append(SESSION_PREFERENCES);
094: buf.append('.');
095: buf.append(namespace);
096: attributeName = buf.toString();
097: }
098:
099: synchronized (session) {
100: pref = (SessionPreferences) session
101: .getAttribute(attributeName);
102:
103: if (pref == null) {
104: pref = new SessionPreferences();
105: session.setAttribute(attributeName, pref);
106: }
107: }
108: }
109:
110: return pref;
111: }
112:
113: public void finish(Map<String, String[]> preferences) {
114: SessionPreferences pref = (SessionPreferences) preferences;
115: pref.updateSessionIfNeeded();
116: }
117: }
|