io.snappydata.jdbc.ClientDataSource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of snappydata-store-client Show documentation
Show all versions of snappydata-store-client Show documentation
SnappyData store based off Pivotal GemFireXD
/*
Derby - Class org.apache.derby.jdbc.ClientDataSource40
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
*/
/*
* Changes for GemFireXD distributed data platform (some marked by "GemStone changes")
*
* Portions Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* 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. See accompanying
* LICENSE file.
*/
/*
* Changes for SnappyData distributed computational and data platform.
*
* Portions Copyright (c) 2017 SnappyData, Inc. All rights reserved.
*
* 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. See accompanying
* LICENSE file.
*/
package io.snappydata.jdbc;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Properties;
import com.gemstone.gemfire.internal.shared.ClientSharedUtils;
import com.pivotal.gemfirexd.internal.client.am.SqlException;
import com.pivotal.gemfirexd.internal.jdbc.ClientBaseDataSource;
import com.pivotal.gemfirexd.jdbc.ClientAttribute;
import io.snappydata.thrift.internal.ClientConnection;
/**
* ClientDataSource is a simple data source implementation
* that can be used for establishing connections in a
* non-pooling, non-distributed environment.
* The class ClientConnectionPoolDataSource can be used in a connection pooling environment,
* and the class ClientXADataSource can be used in a distributed, and pooling
* environment.
*
*
The example below registers a DNC data source object with a JNDI naming service.
*
* io.snappydata.jdbc.ClientDataSource dataSource = new io.snappydata.jdbc.ClientDataSource();
* dataSource.setServerName ("my_database_server");
* dataSource.setDatabaseName ("my_database_name");
* javax.naming.Context context = new javax.naming.InitialContext();
* context.bind ("jdbc/my_datasource_name", dataSource);
*
* The first line of code in the example creates a data source object.
* The next two lines initialize the data source's
* properties. Then a Java object that references the initial JNDI naming
* context is created by calling the
* InitialContext() constructor, which is provided by JNDI.
* System properties (not shown) are used to tell JNDI the
* service provider to use. The JNDI name space is hierarchical,
* similar to the directory structure of many file
* systems. The data source object is bound to a logical JNDI name
* by calling Context.bind(). In this case the JNDI name
* identifies a subcontext, "jdbc", of the root naming context
* and a logical name, "my_datasource_name", within the jdbc
* subcontext. This is all of the code required to deploy
* a data source object within JNDI. This example is provided
* mainly for illustrative purposes. We expect that developers
* or system administrators will normally use a GUI tool to
* deploy a data source object.
*
* Once a data source has been registered with JNDI,
* it can then be used by a JDBC application, as is shown in the
* following example.
*
* javax.naming.Context context = new javax.naming.InitialContext ();
* javax.sql.DataSource dataSource = (javax.sql.DataSource) context.lookup ("jdbc/my_datasource_name");
* java.sql.Connection connection = dataSource.getConnection ("user", "password");
*
* The first line in the example creates a Java object
* that references the initial JNDI naming context. Next, the
* initial naming context is used to do a lookup operation
* using the logical name of the data source. The
* Context.lookup() method returns a reference to a Java Object,
* which is narrowed to a javax.sql.DataSource object. In
* the last line, the DataSource.getConnection() method
* is called to produce a database connection.
*
* This simple data source subclass of ClientBaseDataSource maintains
* it's own private password property.
*
* The specified password, along with the user, is validated by database.
* This property can be overwritten by specifing
* the password parameter on the DataSource.getConnection() method call.
*
* This password property is not declared transient, and therefore
* may be serialized to a file in clear-text, or stored
* to a JNDI server in clear-text when the data source is saved.
* Care must taken by the user to prevent security
* breaches.
*
*
* @see javax.sql.DataSource
*/
public class ClientDataSource extends com.pivotal.gemfirexd.internal.jdbc.ClientDataSource {
public ClientDataSource() {
super();
}
/**
* {@inheritDoc}
*/
@Override
public Connection getConnection() throws SQLException {
if (ClientSharedUtils.isThriftDefault()) {
return getConnection(getUser(), getPassword());
} else {
return super.getConnection();
}
}
/**
* {@inheritDoc}
*/
@Override
public Connection getConnection(String user, String password)
throws SQLException {
if (ClientSharedUtils.isThriftDefault()) {
return ClientConnection.create(getServerName(), getPortNumber(),
getThriftProperties(user, password, this), getLogWriter());
} else {
return super.getConnection(user, password);
}
}
static Properties getThriftProperties(String user, String password,
ClientBaseDataSource dataSource) throws SQLException {
Properties props;
try {
props = tokenizeAttributes(dataSource.getConnectionAttributes(), null);
} catch (SqlException sqle) {
throw sqle.getSQLException(null);
}
if (user != null) {
if (props == null) {
props = new Properties();
}
props.setProperty(ClientAttribute.USERNAME, user);
if (password != null) {
props.setProperty(ClientAttribute.PASSWORD, password);
}
}
int loginTimeout = dataSource.getLoginTimeout();
if (loginTimeout != 0) {
props.setProperty(ClientAttribute.READ_TIMEOUT,
Integer.toString(loginTimeout));
}
String ssl = dataSource.getSsl();
if (ssl != null && !ssl.isEmpty()) {
if (ssl.equalsIgnoreCase("off") || ssl.equalsIgnoreCase("false")) {
props.remove(ClientAttribute.SSL);
} else {
props.put(ClientAttribute.SSL, "true");
if (!ssl.equalsIgnoreCase("basic") && !ssl.equalsIgnoreCase("true")) {
if (ssl.equalsIgnoreCase("peerAuthentication")) {
ssl = "client-auth=true";
}
props.put(ClientAttribute.THRIFT_SSL_PROPERTIES, ssl);
}
}
}
return props;
}
}