1 /**
2 * This file Copyright (c) 2003-2010 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.security;
35
36 import java.util.Date;
37
38 import javax.servlet.http.HttpServletRequest;
39 import javax.servlet.http.HttpSession;
40
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import info.magnolia.context.MgnlContext;
44
45
46 /**
47 * This class is a utility class and does not impose any security rules Its a responsibility of the caller to set and
48 * check for lock to meet specific needs
49 * @author Sameer Charles
50 * @version $Revision: 32667 $ ($Author: gjoseph $)
51 */
52 public final class Lock {
53
54 /**
55 * Logger
56 */
57 private static Logger log = LoggerFactory.getLogger(Lock.class);
58
59 /**
60 * Session lock attribute
61 */
62 private static final String SESSION_LOCK = "mgnlSessionLock"; //$NON-NLS-1$
63
64 /**
65 * System wide lock
66 */
67 private static boolean isSystemLocked;
68
69 /**
70 * System wide lock creation time
71 */
72 private static Date lockSetDate;
73
74 /**
75 * Utility class, don't instantiate.
76 */
77 private Lock() {
78 // unused
79 }
80
81 /**
82 * Set session based lock
83 * @param request
84 */
85 public static void setSessionLock(HttpServletRequest request) {
86 log.info("Session lock enabled for user ( " //$NON-NLS-1$
87 + MgnlContext.getUser().getName()
88 + " ) on " //$NON-NLS-1$
89 + (new Date()).toString());
90 // @todo IMPORTANT remove use of http session
91 HttpSession httpsession = request.getSession(true);
92 httpsession.setAttribute(SESSION_LOCK, (new Date()).toString());
93 }
94
95 /**
96 * returns true if this session is locked
97 * @param request
98 * @return a boolean
99 */
100 public static boolean isSessionLocked(HttpServletRequest request) {
101 // @todo IMPORTANT remove use of http session
102 if (request.getSession(true).getAttribute(Lock.SESSION_LOCK) != null) {
103 return true;
104 }
105 return false;
106 }
107
108 /**
109 * reset session lock
110 * @param request
111 */
112 public static void resetSessionLock(HttpServletRequest request) {
113 if (!Lock.isSessionLocked(request)) {
114 if (log.isDebugEnabled()) {
115 log.debug("No Lock found to reset"); //$NON-NLS-1$
116 }
117 }
118 else {
119 if (log.isDebugEnabled()) {
120 log.debug("Resetting session lock"); //$NON-NLS-1$
121 }
122 Lock.isSystemLocked = false;
123 }
124 // @todo IMPORTANT remove use of http session
125 HttpSession httpsession = request.getSession(true);
126 httpsession.removeAttribute(Lock.SESSION_LOCK);
127 }
128
129 /**
130 * Set system wide lock
131 */
132 public static void setSystemLock() {
133 if (Lock.isSystemLocked()) {
134 if (log.isDebugEnabled()) {
135 log.debug("System lock exist, created on " + Lock.lockSetDate.toString()); //$NON-NLS-1$
136 }
137 }
138 else {
139 Lock.isSystemLocked = true;
140 Lock.lockSetDate = new Date();
141 if (log.isDebugEnabled()) {
142 log.debug("New System lock created on " + Lock.lockSetDate.toString() + " )"); //$NON-NLS-1$
143 }
144 }
145 }
146
147 /**
148 * Reset system wide lock
149 */
150 public static void resetSystemLock() {
151 if (!Lock.isSystemLocked()) {
152 log.debug("No Lock found to reset"); //$NON-NLS-1$
153 }
154 else {
155 if (log.isDebugEnabled()) {
156 log.debug("Resetting system lock created on " + Lock.lockSetDate.toString()); //$NON-NLS-1$
157 }
158 Lock.isSystemLocked = false;
159 }
160 }
161
162 /**
163 * Return true if system is locked
164 * @return a boolean
165 */
166 public static boolean isSystemLocked() {
167 return Lock.isSystemLocked;
168 }
169 }