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