View Javadoc
1   /*
2    * Copyright (c) 2011-2024 PrimeFaces Extensions
3    *
4    *  Permission is hereby granted, free of charge, to any person obtaining a copy
5    *  of this software and associated documentation files (the "Software"), to deal
6    *  in the Software without restriction, including without limitation the rights
7    *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    *  copies of the Software, and to permit persons to whom the Software is
9    *  furnished to do so, subject to the following conditions:
10   *
11   *  The above copyright notice and this permission notice shall be included in
12   *  all copies or substantial portions of the Software.
13   *
14   *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20   *  THE SOFTWARE.
21   */
22  package org.primefaces.extensions.component.session;
23  
24  import java.io.IOException;
25  
26  import javax.faces.component.UIComponent;
27  import javax.faces.context.ExternalContext;
28  import javax.faces.context.FacesContext;
29  import javax.faces.render.FacesRenderer;
30  import javax.servlet.http.HttpSession;
31  
32  import org.primefaces.renderkit.CoreRenderer;
33  import org.primefaces.util.WidgetBuilder;
34  
35  /**
36   * Renderer for the {@link Session} component.
37   *
38   * @author Frank Cornelis
39   * @since 12.0.4
40   */
41  @FacesRenderer(componentFamily = Session.COMPONENT_FAMILY, rendererType = SessionRenderer.RENDERER_TYPE)
42  public class SessionRenderer extends CoreRenderer {
43  
44      public static final String RENDERER_TYPE = "org.primefaces.extensions.component.SessionRenderer";
45  
46      @Override
47      public void encodeBegin(FacesContext facesContext, UIComponent component) throws IOException {
48          Session sessionComponent = (Session) component;
49          Integer reactionPeriod = sessionComponent.getReactionPeriod();
50          if (null == reactionPeriod) {
51              reactionPeriod = 60;
52          }
53  
54          WidgetBuilder wb = getWidgetBuilder(facesContext);
55          wb.init("Session", sessionComponent);
56          wb.attr("reactionPeriod", reactionPeriod);
57          wb.attr("multiWindowSupport", sessionComponent.isMultiWindowSupport());
58          ExternalContext externalContext = facesContext.getExternalContext();
59          HttpSession httpSession = (HttpSession) externalContext.getSession(false);
60          if (httpSession != null) {
61              int maxInactiveInterval = httpSession.getMaxInactiveInterval();
62              if (maxInactiveInterval > 0) {
63                  wb.attr("max_inactive_interval", maxInactiveInterval);
64              }
65          }
66  
67          if (sessionComponent.getOnexpire() != null) {
68              wb.callback("onexpire", "function(e)", sessionComponent.getOnexpire());
69          }
70          if (sessionComponent.getOnexpired() != null) {
71              wb.callback("onexpired", "function(e)", sessionComponent.getOnexpired());
72          }
73  
74          wb.finish();
75      }
76  }