| UpgradeProcess.java |
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.upgrade;
24
25 import com.liferay.portal.kernel.util.InstancePool;
26 import com.liferay.portal.tools.sql.DBUtil;
27
28 import java.io.IOException;
29
30 import java.sql.SQLException;
31
32 import javax.naming.NamingException;
33
34 /**
35 * <a href="UpgradeProcess.java.html"><b><i>View Source</i></b></a>
36 *
37 * @author Brian Wing Shun Chan
38 * @author Alexander Chow
39 *
40 */
41 public abstract class UpgradeProcess {
42
43 public UpgradeProcess() {
44 }
45
46 public int getThreshold() {
47
48 // This upgrade process will only run if the build number is larger than
49 // the returned threshold value. Return 0 to always run this upgrade
50 // process.
51
52 return 0;
53 }
54
55 public void runSQL(String template)
56 throws IOException, NamingException, SQLException {
57
58 DBUtil.getInstance().runSQL(template);
59 }
60
61 public void runSQL(String[] templates)
62 throws IOException, NamingException, SQLException {
63
64 DBUtil.getInstance().runSQL(templates);
65 }
66
67 public void runSQLTemplate(String path)
68 throws IOException, NamingException, SQLException {
69
70 DBUtil.getInstance().runSQLTemplate(path);
71 }
72
73 public void runSQLTemplate(String path, boolean failOnError)
74 throws IOException, NamingException, SQLException {
75
76 DBUtil.getInstance().runSQLTemplate(path, failOnError);
77 }
78
79 public abstract void upgrade() throws UpgradeException;
80
81 public void upgrade(Class<?> upgradeProcessClass)
82 throws UpgradeException {
83
84 UpgradeProcess upgradeProcess = (UpgradeProcess)InstancePool.get(
85 upgradeProcessClass.getName());
86
87 upgradeProcess.upgrade();
88 }
89
90 public void upgrade(UpgradeProcess upgradeProcess)
91 throws UpgradeException {
92
93 upgradeProcess.upgrade();
94 }
95
96 }