org.springframework.boot.autoconfigure.jdbc.plus.MysqlUrl Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2017 the original author or authors.
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.springframework.boot.autoconfigure.jdbc.plus;

/**
 * {@link JdbcUrl} for MySQL
 */
public class MysqlUrl extends JdbcUrl {
	
	/**
	 * Prefix
	 */
	public static final String PREFIX = "jdbc:mysql:";
	
	/**
	 * URL is valid?
	 * 
	 * @param url URL
	 * @return {@code true} if URL is valid
	 */
	public static boolean isValid(String url) {
		
		try {
			
			create(url);
			
			return true;
		}
		catch (IllegalArgumentException e) {
			
			return false;
		}
	}
	
	/**
	 * Create
	 * 
	 * @param url URL
	 * @return {@link MysqlUrl}
	 * @throws IllegalArgumentException if failed to parse URL
	 */
	public static MysqlUrl create(String url) throws IllegalArgumentException {
		
		return new MysqlUrl(url);
	}
	
	/**
	 * Constructor
	 * 
	 * @param url URL
	 * @throws IllegalArgumentException if failed to parse URL
	 */
	protected MysqlUrl(String url) throws IllegalArgumentException {
		
		super(url);
	}
	
	@Override
	protected String getUrlPattern() {
		
		return "^" + PREFIX + "([^\\?]+)(.*?)$";
	}
	
	@Override
	protected String getPrefix() {
		
		return PREFIX;
	}
	
	@Override
	protected String getQueryStarter() {
		
		return "?";
	}
	
	@Override
	protected String getQueryJoiner() {
		
		return "&";
	}
	
	@Override
	protected String getParamJoiner() {
		
		return "=";
	}
	
	/**
	 * Add parameter
	 * 
	 * @param key key
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl param(String key, Object value) {
		
		this.addParam(key, value);
		
		return this;
	}
	
	/**
	 * characterEncoding
	 * 
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl characterEncoding(String value) {
		
		this.addParam("characterEncoding", value);
		
		return this;
	}
	
	/**
	 * connectTimeout
	 * 
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl connectTimeout(int value) {
		
		this.addParam("connectTimeout", value);
		
		return this;
	}
	
	/**
	 * createDatabaseIfNotExist
	 * 
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl createDatabaseIfNotExist(boolean value) {
		
		this.addParam("createDatabaseIfNotExist", value);
		
		return this;
	}
	
	/**
	 * socketTimeout
	 * 
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl socketTimeout(int value) {
		
		this.addParam("socketTimeout", value);
		
		return this;
	}
	
	/**
	 * useUnicode
	 * 
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl useUnicode(boolean value) {
		
		this.addParam("useUnicode", value);
		
		return this;
	}
	
	/**
	 * zeroDateTimeBehavior
	 * 
	 * @param value value
	 * @return {@link MysqlUrl}
	 */
	public MysqlUrl zeroDateTimeBehavior(String value) {
		
		this.addParam("zeroDateTimeBehavior", value);
		
		return this;
	}
}