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.convert;
24  
25  import com.liferay.portal.kernel.log.Log;
26  import com.liferay.portal.kernel.log.LogFactoryUtil;
27  import com.liferay.portal.util.MaintenanceUtil;
28  
29  /**
30   * <a href="ConvertProcess.java.html"><b><i>View Source</i></b></a>
31   *
32   * @author Alexander Chow
33   *
34   */
35  public abstract class ConvertProcess {
36  
37      public void convert() throws ConvertException {
38          try {
39              if (getPath() != null) {
40                  return;
41              }
42  
43              _log.info("Converting");
44  
45              doConvert();
46  
47              _log.info("Conversion complete");
48          }
49          catch (Exception e) {
50              throw new ConvertException(e);
51          }
52          finally {
53              MaintenanceUtil.cancel();
54          }
55      }
56  
57      public abstract String getDescription();
58  
59      public String getPath() {
60          return null;
61      }
62  
63      public abstract boolean isEnabled();
64  
65      protected abstract void doConvert() throws Exception;
66  
67      private static Log _log = LogFactoryUtil.getLog(ConvertProcess.class);
68  
69  }