001    /**
002     * Copyright 2005-2011 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.test.lifecycles;
017    
018    import org.apache.log4j.Logger;
019    import org.kuali.rice.core.api.config.property.ConfigContext;
020    import org.kuali.rice.core.api.lifecycle.BaseLifecycle;
021    import org.kuali.rice.kew.batch.KEWXmlDataLoader;
022    
023    /**
024     * A lifecycle for loading KEW XML datasets.
025     * This lifecycle will not be run (even if it is listed in the lifecycles list)
026     * if the 'use.kewXmlmlDataLoaderLifecycle' configuration property is defined, and is
027     * not 'true'.  If the property is omitted the lifecycle runs as normal.
028     * 
029     * @author Kuali Rice Team (rice.collab@kuali.org)
030     */
031    public class KEWXmlDataLoaderLifecycle extends BaseLifecycle {
032        private static final Logger LOG = Logger.getLogger(KEWXmlDataLoaderLifecycle.class);
033    
034        private String filename;
035    
036        /**
037         * Specifies the XML resource to load.  The resource path should be in Spring resource notation.
038         * @param resource the XML resource to load
039         */
040        public KEWXmlDataLoaderLifecycle(String resource) {
041            this.filename = resource;
042        }
043    
044        public void start() throws Exception {
045            String useKewXmlDataLoaderLifecycle = ConfigContext.getCurrentContextConfig().getProperty("use.kewXmlmlDataLoaderLifecycle");
046    
047            if (useKewXmlDataLoaderLifecycle != null && !Boolean.valueOf(useKewXmlDataLoaderLifecycle)) {
048                LOG.debug("Skipping KEWXmlDataLoaderLifecycle due to property: use.kewXmlmlDataLoaderLifecycle=" + useKewXmlDataLoaderLifecycle);
049                return;
050            }
051    
052            LOG.info("################################");
053            LOG.info("#");
054            LOG.info("#  Begin Loading file '" + filename + "'");
055            LOG.info("#");
056            LOG.info("################################");
057            loadData();
058            super.start();
059        }
060    
061        /**
062         * Does the work of loading the data
063         * @throws Exception
064         */
065        protected void loadData() throws Exception {
066            KEWXmlDataLoader.loadXmlResource(filename);
067        }
068    }