1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.upgrade;
21  
22  import com.liferay.portal.kernel.util.InstancePool;
23  import com.liferay.portal.tools.sql.DBUtil;
24  
25  import java.io.IOException;
26  
27  import java.sql.SQLException;
28  
29  import javax.naming.NamingException;
30  
31  /**
32   * <a href="UpgradeProcess.java.html"><b><i>View Source</i></b></a>
33   *
34   * @author Brian Wing Shun Chan
35   * @author Alexander Chow
36   *
37   */
38  public abstract class UpgradeProcess {
39  
40      public UpgradeProcess() {
41      }
42  
43      public int getThreshold() {
44  
45          // This upgrade process will only run if the build number is larger than
46          // the returned threshold value. Return 0 to always run this upgrade
47          // process.
48  
49          return 0;
50      }
51  
52      public void runSQL(String template)
53          throws IOException, NamingException, SQLException {
54  
55          DBUtil.getInstance().runSQL(template);
56      }
57  
58      public void runSQL(String[] templates)
59          throws IOException, NamingException, SQLException {
60  
61          DBUtil.getInstance().runSQL(templates);
62      }
63  
64      public void runSQLTemplate(String path)
65          throws IOException, NamingException, SQLException {
66  
67          DBUtil.getInstance().runSQLTemplate(path);
68      }
69  
70      public void runSQLTemplate(String path, boolean failOnError)
71          throws IOException, NamingException, SQLException {
72  
73          DBUtil.getInstance().runSQLTemplate(path, failOnError);
74      }
75  
76      public abstract void upgrade() throws UpgradeException;
77  
78      public void upgrade(Class<?> upgradeProcessClass)
79          throws UpgradeException {
80  
81          UpgradeProcess upgradeProcess = (UpgradeProcess)InstancePool.get(
82              upgradeProcessClass.getName());
83  
84          upgradeProcess.upgrade();
85      }
86  
87      public void upgrade(UpgradeProcess upgradeProcess)
88          throws UpgradeException {
89  
90          upgradeProcess.upgrade();
91      }
92  
93  }