org.kuali.common.util.config.spring.BasicPropertySourceConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kuali-util Show documentation

Kuali Utilities

There is a newer version: 4.4.17

/**
 * Copyright 2010-2014 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.opensource.org/licenses/ecl2.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.common.util.config.spring;

import java.util.Collections;
import java.util.List;
import java.util.Properties;

import org.kuali.common.util.spring.SpringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.core.env.PropertySource;

/**
 * @deprecated
 */
@Deprecated
@Configuration
@Import({ ConfigServiceConfig.class })
public class BasicPropertySourceConfig {

	@Autowired
	ConfigServiceConfig utilConfigServiceConfig;

	/**
	 * 
	 * Returns Collections.emptyList() by default. Override this method to pull in properties from other locations
	 * 
	 * 
	 * Example configIds:
	 * 
	 * 	 *   org.kuali.common:kuali-sql
	 *   org.kuali.common:kuali-util:scm
	 *   org.kuali.common:kuali-util:metainf:mpx
	 *   org.kuali.common:kuali-util:metainf:sql
	 * 
	 */
	protected List getConfigIds() {
		return Collections.emptyList();
	}

	/**
	 * 
	 * Returns an empty properties object by default. Override this method to inject properties that will override anything loaded from other locations
	 * 
	 */
	protected Properties getOverrides() {
		return new Properties();
	}

	/**
	 * Combine loaded properties, project properties, and system/environment properties into a PropertySource
	 */
	protected PropertySource getPropertySource() {
		org.kuali.common.util.config.service.ConfigService service = utilConfigServiceConfig.configService();
		List configIds = getConfigIds();
		Properties properties = service.getProperties(configIds, getOverrides());
		return SpringUtils.getGlobalPropertySource(properties);
	}

	@Bean
	public PropertySource springPropertySource() {
		return getPropertySource();
	}

}