001/**
002 * Copyright 2005-2014 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 */
016package org.kuali.rice.test.lifecycles;
017
018import org.apache.logging.log4j.Logger;
019import org.apache.logging.log4j.LogManager;
020import org.kuali.rice.core.api.config.property.ConfigContext;
021import org.kuali.rice.core.api.lifecycle.BaseLifecycle;
022import org.kuali.rice.kew.batch.KEWXmlDataLoader;
023
024/**
025 * A lifecycle for loading KEW XML datasets.
026 * This lifecycle will not be run (even if it is listed in the lifecycles list)
027 * if the 'use.kewXmlmlDataLoaderLifecycle' configuration property is defined, and is
028 * not 'true'.  If the property is omitted the lifecycle runs as normal.
029 * 
030 * @author Kuali Rice Team (rice.collab@kuali.org)
031 */
032public class KEWXmlDataLoaderLifecycle extends BaseLifecycle {
033    private static final Logger LOG = LogManager.getLogger(KEWXmlDataLoaderLifecycle.class);
034
035    private String filename;
036
037    /**
038     * Specifies the XML resource to load.  The resource path should be in Spring resource notation.
039     * @param resource the XML resource to load
040     */
041    public KEWXmlDataLoaderLifecycle(String resource) {
042        this.filename = resource;
043    }
044
045    public void start() throws Exception {
046        String useKewXmlDataLoaderLifecycle = ConfigContext.getCurrentContextConfig().getProperty("use.kewXmlmlDataLoaderLifecycle");
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}