1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
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 THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.util;
24  
25  import javax.portlet.PortletRequest;
26  import javax.portlet.PortletSession;
27  
28  import javax.servlet.http.HttpServletRequest;
29  import javax.servlet.http.HttpSession;
30  
31  /**
32   * <a href="ProgressTracker.java.html"><b><i>View Source</i></b></a>
33   *
34   * @author Jorge Ferrer
35   */
36  public class ProgressTracker {
37  
38      public static final String PERCENT =
39          ProgressTracker.class.getName() + "_PERCENT";
40  
41      public ProgressTracker(HttpServletRequest request, String progressId) {
42          _request = request;
43          _progressId = progressId;
44      }
45  
46      public ProgressTracker(PortletRequest portletRequest, String progressId) {
47          _portletRequest = portletRequest;
48          _progressId = progressId;
49      }
50  
51      public void start() {
52          updateProgress(1);
53      }
54  
55      public void updateProgress(int percentage) {
56          if (_request != null) {
57              HttpSession session = _request.getSession(true);
58  
59              session.setAttribute(
60                  PERCENT + _progressId, new Integer(percentage));
61          }
62          else {
63              PortletSession portletSession = _portletRequest.getPortletSession(
64                  true);
65  
66              portletSession.setAttribute(
67                  PERCENT + _progressId, new Integer(percentage),
68                  PortletSession.APPLICATION_SCOPE);
69          }
70      }
71  
72      public void finish() {
73          if (_request != null) {
74              HttpSession session = _request.getSession(true);
75  
76              session.removeAttribute(PERCENT + _progressId);
77          }
78          else {
79              PortletSession portletSession = _portletRequest.getPortletSession(
80                  true);
81  
82              portletSession.removeAttribute(
83                  PERCENT + _progressId, PortletSession.APPLICATION_SCOPE);
84          }
85      }
86  
87      private HttpServletRequest _request;
88      private PortletRequest _portletRequest;
89      private String _progressId;
90  
91  }