View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.webapp.filter.portlet;
20  
21  import org.apache.myfaces.shared_tomahawk.util.NullEnumeration;
22  
23  import java.util.Enumeration;
24  import java.util.Map;
25  import javax.portlet.PortletRequest;
26  import javax.portlet.PortletSession;
27  import org.apache.myfaces.webapp.filter.servlet.AbstractAttributeMap;
28  
29  /**
30   * Portlet scope PortletSession attibutes as Map.
31   * <p>
32   * NOTE: This class was copied from myfaces impl 
33   * org.apache.myfaces.context.portlet and it is
34   * used by TomahawkFacesContextWrapper. By that reason, it could change
35   * in the future.
36   * </p>
37   * 
38   * @since 1.1.7
39   * @author  Stan Silvert (latest modification by $Author: lu4242 $)
40   * @version $Revision: 691871 $ $Date: 2008-09-03 23:32:08 -0500 (Wed, 03 Sep 2008) $
41   */
42  public class SessionMap extends AbstractAttributeMap
43  {
44      private final PortletRequest _portletRequest;
45  
46      SessionMap(PortletRequest portletRequest)
47      {
48          _portletRequest = portletRequest;
49      }
50  
51      protected Object getAttribute(String key)
52      {
53          PortletSession portletSession = getSession();
54          return (portletSession == null)
55                 ? null : portletSession.getAttribute(key.toString(), PortletSession.PORTLET_SCOPE);
56      }
57  
58      protected void setAttribute(String key, Object value)
59      {
60          _portletRequest.getPortletSession(true).setAttribute(key, value, PortletSession.PORTLET_SCOPE);
61      }
62  
63      protected void removeAttribute(String key)
64      {
65          PortletSession portletSession = getSession();
66          if (portletSession != null)
67          {
68              portletSession.removeAttribute(key, PortletSession.PORTLET_SCOPE);
69          }
70      }
71  
72      protected Enumeration getAttributeNames()
73      {
74          PortletSession portletSession = getSession();
75          return (portletSession == null)
76                 ? NullEnumeration.instance()
77                 : portletSession.getAttributeNames(PortletSession.PORTLET_SCOPE);
78      }
79  
80      private PortletSession getSession()
81      {
82          return _portletRequest.getPortletSession(false);
83      }
84  
85      public void putAll(Map t)
86      {
87          throw new UnsupportedOperationException();
88      }
89  
90  
91      public void clear()
92      {
93          throw new UnsupportedOperationException();
94      }
95  }