View Javadoc

1   /**
2    * Copyright 2005-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.test.lifecycles;
17  
18  import org.apache.log4j.Logger;
19  import org.kuali.rice.core.api.config.property.ConfigContext;
20  import org.kuali.rice.core.api.lifecycle.BaseLifecycle;
21  import org.kuali.rice.kew.batch.KEWXmlDataLoader;
22  
23  /**
24   * A lifecycle for loading KEW XML datasets.
25   * This lifecycle will not be run (even if it is listed in the lifecycles list)
26   * if the 'use.kewXmlmlDataLoaderLifecycle' configuration property is defined, and is
27   * not 'true'.  If the property is omitted the lifecycle runs as normal.
28   * 
29   * @author Kuali Rice Team (rice.collab@kuali.org)
30   */
31  public class KEWXmlDataLoaderLifecycle extends BaseLifecycle {
32      private static final Logger LOG = Logger.getLogger(KEWXmlDataLoaderLifecycle.class);
33  
34      private String filename;
35  
36      /**
37       * Specifies the XML resource to load.  The resource path should be in Spring resource notation.
38       * @param resource the XML resource to load
39       */
40      public KEWXmlDataLoaderLifecycle(String resource) {
41          this.filename = resource;
42      }
43  
44      public void start() throws Exception {
45          String useKewXmlDataLoaderLifecycle = ConfigContext.getCurrentContextConfig().getProperty("use.kewXmlmlDataLoaderLifecycle");
46  
47          if (useKewXmlDataLoaderLifecycle != null && !Boolean.valueOf(useKewXmlDataLoaderLifecycle)) {
48              LOG.debug("Skipping KEWXmlDataLoaderLifecycle due to property: use.kewXmlmlDataLoaderLifecycle=" + useKewXmlDataLoaderLifecycle);
49              return;
50          }
51  
52          LOG.info("################################");
53          LOG.info("#");
54          LOG.info("#  Begin Loading file '" + filename + "'");
55          LOG.info("#");
56          LOG.info("################################");
57          loadData();
58          super.start();
59      }
60  
61      /**
62       * Does the work of loading the data
63       * @throws Exception
64       */
65      protected void loadData() throws Exception {
66          KEWXmlDataLoader.loadXmlResource(filename);
67      }
68  }