net.sf.mongodb_jdbc_driver.DriverPropertyInfoHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongojdbcdriver Show documentation
JDBC driver for MongoDB
The newest version!
/*
 * Copyright (C) 2012 Rob Manning
 * [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package net.sf.mongodb_jdbc_driver;

import java.sql.DriverPropertyInfo;
import java.util.ArrayList;
import java.util.Properties;

import com.mongodb.MongoOptions;
import com.mongodb.ReadPreference;

public class DriverPropertyInfoHelper
{
	public static final String AUTO_CONNECT_RETRY = "autoConnectRetry";

	public static final String CONNECTIONS_PER_HOST = "connecionsPerHost";

	public static final String CONNECT_TIMEOUT = "connectTimeout";

	public static final String CURSOR_FINALIZER_ENABLED = "cursorFinalizerEnabled";

	public static final String MAX_AUTO_CONNECT_RETRY_TIME = "maxAutoConnectRetryTime";

	public static final String READ_PREFERENCE = "readPreference";

	public static final String SOCKET_TIMEOUT = "socketTimeout";

	public MongoOptions getMongoOptions(Properties props)
	{
		MongoOptions result = new MongoOptions();

		if (props.containsKey(AUTO_CONNECT_RETRY))
		{
			result.setAutoConnectRetry(Boolean.valueOf((String) props.get(AUTO_CONNECT_RETRY)));
		}
		if (props.containsKey(CONNECTIONS_PER_HOST))
		{
			int connectionsPerHost = Integer.parseInt((String) props.get(CONNECTIONS_PER_HOST));
			result.setConnectionsPerHost(connectionsPerHost);
		}
		if (props.containsKey(CONNECT_TIMEOUT))
		{
			int connectionTimeout = Integer.parseInt((String) props.get(CONNECT_TIMEOUT));
			result.setConnectionsPerHost(connectionTimeout);
		}

		if (props.containsKey(CURSOR_FINALIZER_ENABLED))
		{
			boolean cursorFinalizerEnabled = Boolean.valueOf((String) props.get(CURSOR_FINALIZER_ENABLED));
			result.setCursorFinalizerEnabled(cursorFinalizerEnabled);
		}
		if (props.containsKey(MAX_AUTO_CONNECT_RETRY_TIME))
		{
			int retryTime = Integer.parseInt((String) props.get(MAX_AUTO_CONNECT_RETRY_TIME));
			result.setMaxAutoConnectRetryTime(retryTime);
		}
		if (props.containsKey(READ_PREFERENCE))
		{
			result.setReadPreference(ReadPreference.valueOf((String) props.get(READ_PREFERENCE)));
		}
		if (props.containsKey(SOCKET_TIMEOUT))
		{
			int socketTimeout = Integer.parseInt((String) props.get(SOCKET_TIMEOUT));
			result.setSocketTimeout(socketTimeout);
		}

		return result;
	}

	public DriverPropertyInfo[] getPropertyInfo()
	{
		ArrayList propInfos = new ArrayList();

		addPropInfo(
			propInfos,
			AUTO_CONNECT_RETRY,
			"false",
			"If true, the driver will keep trying to connect to the same server in case that the socket "
				+ "cannot be established. There is maximum amount of time to keep retrying, which is 15s by "
				+ "default. This can be useful to avoid some exceptions being thrown when a server is down "
				+ "temporarily by blocking the operations. It also can be useful to smooth the transition to a "
				+ "new master (so that a new master is elected within the retry time). Note that when using this "
				+ "flag: - for a replica set, the driver will trying to connect to the old master for that "
				+ "time, instead of failing over to the new one right away - this does not prevent exception "
				+ "from being thrown in read/write operations on the socket, which must be handled by "
				+ "application Even if this flag is false, the driver already has mechanisms to "
				+ "automatically recreate broken connections " + "and retry the read operations.", null);

		addPropInfo(propInfos, CONNECTIONS_PER_HOST, "10", "The maximum number of connections allowed per "
			+ "host for this Mongo instance. Those connections will be kept in a pool when idle. Once the "
			+ "pool is exhausted, any operation requiring a connection will block waiting for an available "
			+ "connection.", null);

		addPropInfo(propInfos, CONNECT_TIMEOUT, "10000", "The connection timeout in milliseconds. A value "
			+ "of 0 means no timeout. It is used solely when establishing a new connection "
			+ "Socket.connect(java.net.SocketAddress, int)", null);

		addPropInfo(propInfos, CURSOR_FINALIZER_ENABLED, "true", "Sets whether there is a a finalize "
			+ "method created that cleans up instances of DBCursor that the client does not close. If you "
			+ "are careful to always call the close method of DBCursor, then this can safely be set to false.",
			null);

		addPropInfo(propInfos, MAX_AUTO_CONNECT_RETRY_TIME, "0",
			"The maximum amount of time in MS to spend retrying to open connection to the same server. "
				+ "Default is 0, which means to use the default 15s if autoConnectRetry is on.", null);

		addPropInfo(propInfos, READ_PREFERENCE, "primary",
			"represents preferred replica set members to which a query or command can be sent", new String[] {
					"primary", "primary preferred", "secondary", "secondary preferred", "nearest" });

		addPropInfo(propInfos, SOCKET_TIMEOUT, "0", "The socket timeout in milliseconds It is used for "
			+ "I/O socket read and write operations "
			+ "Socket.setSoTimeout(int) Default is 0 and means no timeout.", null);

		return propInfos.toArray(new DriverPropertyInfo[propInfos.size()]);
	}

	private void addPropInfo(final ArrayList propInfos, final String propName,
		final String defaultVal, final String description, final String[] choices)
	{
		DriverPropertyInfo newProp = new DriverPropertyInfo(propName, defaultVal);
		newProp.description = description;
		if (choices != null)
		{
			newProp.choices = choices;
		}
		propInfos.add(newProp);
	}
}