org.apache.torque.util.JdbcConfigurer Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2004-2012 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.apache.torque.util;

import static org.apache.commons.lang.StringUtils.isBlank;
import static org.apache.commons.lang.StringUtils.isEmpty;

import java.util.Map;

import org.apache.commons.beanutils.BeanUtils;
import org.kuali.core.db.torque.PropertyHandlingException;
import org.kuali.db.DatabaseType;
import org.kuali.db.JDBCConfiguration;
import org.kuali.db.JDBCUtils;

public class JdbcConfigurer {
	JDBCUtils jdbcUtils = new JDBCUtils();

	@SuppressWarnings("unchecked")
	protected boolean hasProperty(String name, Object bean) throws PropertyHandlingException {
		try {
			Map description = BeanUtils.describe(bean);
			return description.containsKey(name);
		} catch (Exception e) {
			throw new PropertyHandlingException(e);
		}

	}

	@SuppressWarnings("unchecked")
	protected  T getProperty(String name, Object bean) {
		try {
			if (hasProperty(name, bean)) {
				return (T) BeanUtils.getProperty(bean, name);
			} else {
				return null;
			}
		} catch (Exception e) {
			throw new RuntimeException(e);
		}
	}

	protected void setProperty(Object bean, String name, Object value) throws PropertyHandlingException {
		try {
			BeanUtils.copyProperty(bean, name, value);
		} catch (Exception e) {
			throw new PropertyHandlingException(e);
		}
	}

	public void updateConfiguration(Object bean) throws PropertyHandlingException {
		String url = getProperty("url", bean);
		if (isEmpty(url)) {
			// If the url is empty, there is nothing to do
			return;
		}

		JDBCConfiguration config = jdbcUtils.getDatabaseConfiguration(url);
		if (config.equals(JDBCConfiguration.UNKNOWN_CONFIG)) {
			return;
		}

		String driver = getProperty("driver", bean);
		if (isBlank(driver)) {
			setProperty(bean, "driver", config.getDriver());
		}

		String targetDatabase = getProperty("targetDatabase", bean);
		if (isBlank(targetDatabase)) {
			setProperty(bean, "targetDatabase", config.getType().toString().toLowerCase());
		}
	}

	public void validateConfiguration(Object bean) {
		String driver = getProperty("driver", bean);
		if (isBlank(driver)) {
			throw new IllegalArgumentException("No database driver. Specify one in the plugin configuration.");
		}

		String url = getProperty("url", bean);
		if (isBlank(url)) {
			throw new IllegalArgumentException(getEmptyURLErrorMessage());
		}

		String targetDatabase = getProperty("targetDatabase", bean);
		try {
			DatabaseType.valueOf(targetDatabase.toUpperCase());
		} catch (IllegalArgumentException e) {
			throw new IllegalArgumentException("Database type of '" + targetDatabase + "' is invalid.  Valid values: " + org.springframework.util.StringUtils.arrayToCommaDelimitedString(DatabaseType.values()));
		}

		try {
			Class.forName(driver);
		} catch (ClassNotFoundException e) {
			throw new IllegalArgumentException("Can't load driver class " + driver + ". Be sure to include it as a plugin dependency.");
		}
	}

	protected String getEmptyURLErrorMessage() {
		StringBuffer sb = new StringBuffer();
		sb.append("\n\n");
		sb.append("No url was supplied.\n");
		sb.append("You can specify a url in the plugin configuration or provide it as a system property.\n\n");
		sb.append("For example:\n\n");
		sb.append("-Durl=jdbc:oracle:thin:@localhost:1521:XE (oracle)\n");
		sb.append("-Durl=jdbc:mysql://localhost:3306/ (mysql)\n");
		sb.append("\n.");
		return sb.toString();
	}
}