com.sun.gjc.spi.DMManagedConnectionFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2018-2021] Payara Foundation and/or affiliates
package com.sun.gjc.spi;
import com.sun.gjc.common.DataSourceObjectBuilder;
import com.sun.gjc.common.DataSourceSpec;
import com.sun.gjc.util.SecurityUtils;
import com.sun.logging.LogDomains;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.Hashtable;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.Vector;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.resource.ResourceException;
import jakarta.resource.spi.ConfigProperty;
import jakarta.resource.spi.ConnectionDefinition;
import jakarta.resource.spi.ConnectionRequestInfo;
import jakarta.resource.spi.security.PasswordCredential;
/**
* Driver Manager ManagedConnectionFactory implementation for Generic JDBC Connector.
*
* @author Evani Sai Surya Kiran
* @version 1.0, 02/07/31
*/
@ConnectionDefinition(
connectionFactory = javax.sql.DataSource.class,
connectionFactoryImpl = com.sun.gjc.spi.base.AbstractDataSource.class,
connection = java.sql.Connection.class,
connectionImpl = com.sun.gjc.spi.base.ConnectionHolder.class
)
public class DMManagedConnectionFactory extends ManagedConnectionFactoryImpl {
Properties props;
private static Logger _logger;
static {
_logger = LogDomains.getLogger(DMManagedConnectionFactory.class, LogDomains.RSR_LOGGER);
}
private boolean debug = _logger.isLoggable(Level.FINE);
/**
* Creates a new physical connection to the underlying EIS resource
* manager.
*
* @param subject Subject instance passed by the application server
* @param cxRequestInfo ConnectionRequestInfo which may be created
* as a result of the invocation getConnection(user, password)
* on the DataSource object
* @return ManagedConnection object created
* @throws ResourceException if there is an error in instantiating the
* DataSource object used for the
* creation of the ManagedConnection object
* @throws SecurityException if there ino PasswordCredential object
* satisfying this request
*/
@Override
public jakarta.resource.spi.ManagedConnection createManagedConnection(javax.security.auth.Subject subject,
ConnectionRequestInfo cxRequestInfo) throws ResourceException {
logFine("In createManagedConnection");
if (dsObjBuilder == null) {
dsObjBuilder = new DataSourceObjectBuilder(spec);
}
PasswordCredential pc = SecurityUtils.getPasswordCredential(this, subject, cxRequestInfo);
try {
Class.forName(spec.getDetail(DataSourceSpec.CLASSNAME));
} catch (ClassNotFoundException cnfe) {
_logger.log(Level.SEVERE, "jdbc.exc_cnfe", cnfe);
throw new ResourceException("The driver could not be loaded: " + spec.getDetail(DataSourceSpec.CLASSNAME));
}
java.sql.Connection dsConn = null;
ManagedConnectionImpl mc = null;
Properties driverProps = new Properties();
//Will return a set of properties that would have setURL and as objects
//Get a set of normal case properties
Hashtable properties = dsObjBuilder.parseDriverProperties(spec, false);
Set> entries =
properties.entrySet();
for(Map.Entry entry : entries) {
String value = "";
String key = entry.getKey();
Vector values = entry.getValue();
if(!values.isEmpty() && values.size() == 1) {
value = (String) values.firstElement();
} else if(values.size() > 1) {
logFine("More than one value for key : " + key);
}
String prop = getParsedKey(key);
driverProps.put(prop, value);
if(prop.equalsIgnoreCase("URL")) {
if(spec.getDetail(DataSourceSpec.URL) == null) {
setConnectionURL(value);
}
}
}
try {
if (cxRequestInfo != null) {
driverProps.setProperty("user", pc.getUserName());
driverProps.setProperty("password", new String(pc.getPassword()));
} else {
String user = spec.getDetail(DataSourceSpec.USERNAME);
String password = spec.getDetail(DataSourceSpec.PASSWORD);
if(user != null) {
driverProps.setProperty("user", user);
}
if(password != null) {
driverProps.setProperty("password", password);
}
}
dsConn = DriverManager.getConnection(spec.getDetail(DataSourceSpec.URL), driverProps);
} catch (java.sql.SQLException sqle) {
_logger.log(Level.SEVERE, "jdbc.exc_create_mc", sqle);
throw new jakarta.resource.spi.ResourceAllocationException("The connection could not be allocated: " +
sqle.getMessage());
}
try {
mc = constructManagedConnection(null, dsConn, pc, this);
//GJCINT
validateAndSetIsolation(mc);
} finally {
if (mc == null) {
if (dsConn != null) {
try {
dsConn.close();
} catch (SQLException e) {
_logger.log(Level.FINEST, "Exception while closing connection : createManagedConnection" + dsConn);
}
}
}
}
return mc;
}
/**
* Parses the key and removes the "set" string at the beginning of the
* property.
* @param key
* @return
*/
private static String getParsedKey(String key) throws ResourceException {
String property = key != null && key.startsWith("set") ? key.substring(3).trim() : key;
if (property == null || property.isEmpty()) {
throw new ResourceException("Invalid driver properties string - " +
"Key cannot be an empty string");
}
return property;
}
/**
* This method checks if the properties object is null or not.
* If the properties object is null, it creates a new Properties
* object and inserts the default "user" and "password" key value
* pairs. It checks if any other properties have been set or not
* and includes the key value pairs for those properties.
*
* @return props Properties object conatining properties for getting a connection
* @throws ResourceException if the driver properties string and delimiter are not proper
*/
//TODO remove unused method
/*private Properties getPropertiesObj() throws ResourceException {
if (props != null) {
return props;
}
props = new Properties();
props.setProperty("user", getUser());
props.setProperty("password", getPassword());
String driverProps = spec.getDetail(DataSourceSpec.DRIVERPROPERTIES);
String delimiter = spec.getDetail(DataSourceSpec.DELIMITER);
if (driverProps != null && driverProps.trim().equals("") == false) {
if (delimiter == null || delimiter.equals("")) {
throw new ResourceException("Invalid driver properties string - " +
"delimiter not properly set!!");
}
StringTokenizer st = new StringTokenizer(driverProps, delimiter);
while (st.hasMoreTokens()) {
String keyValuePair = null;
try {
keyValuePair = st.nextToken();
} catch (NoSuchElementException nsee) {
throw new ResourceException("Invalid driver properties string - " +
"Key value pair not available: " + nsee.getMessage());
}
int indexOfEqualsSign = -1;
try {
indexOfEqualsSign = keyValuePair.indexOf("=");
if (indexOfEqualsSign == -1) {
throw new ResourceException("Invalid driver properties string - " +
"Key value pair should be of the form key = value");
}
} catch (NullPointerException npe) {
if (debug) {
_logger.log(Level.FINE, "jdbc.exc_caught_ign", npe.getMessage());
}
}
String key = null;
try {
key = keyValuePair.substring(0, indexOfEqualsSign).trim();
} catch (IndexOutOfBoundsException iobe) {
if (debug) {
_logger.log(Level.FINE, "jdbc.exc_caught_ign", iobe.getMessage());
}
}
if (key != null && key.equals("")) {
throw new ResourceException("Invalid driver properties string - " +
"Key cannot be an empty string");
}
String value = null;
try {
value = keyValuePair.substring(indexOfEqualsSign + 1).trim();
} catch (IndexOutOfBoundsException iobe) {
if (debug) {
_logger.log(Level.FINE, "jdbc.exc_caught_ign", iobe.getMessage());
}
}
props.setProperty(key, value);
}
}
return props;
} */
/**
* Check if this ManagedConnectionFactory is equal to
* another ManagedConnectionFactory.
*
* @param other ManagedConnectionFactory object for checking equality with
* @return true if the property sets of both the
* ManagedConnectionFactory objects are the same
* false otherwise
*/
public boolean equals(Object other) {
logFine("In equals");
/**
* The check below means that two ManagedConnectionFactory objects are equal
* if and only if their properties are the same.
*/
if (other instanceof com.sun.gjc.spi.DMManagedConnectionFactory) {
com.sun.gjc.spi.DMManagedConnectionFactory otherMCF =
(com.sun.gjc.spi.DMManagedConnectionFactory) other;
return this.spec.equals(otherMCF.spec);
}
return false;
}
@Override
public int hashCode() {
return 31 * 7 + (spec.hashCode());
}
/**
* Sets the login timeout.
*
* @param loginTimeOut String
* @see getLoginTimeOut
*/
public void setLoginTimeOut(String loginTimeOut) {
int timeOut = 0;
try {
timeOut = Integer.parseInt(loginTimeOut);
DriverManager.setLoginTimeout(timeOut);
spec.setDetail(DataSourceSpec.LOGINTIMEOUT, loginTimeOut);
} catch (Exception e) {
if (debug) {
_logger.log(Level.FINE, "jdbc.exc_caught_ign", e.getMessage());
}
}
}
/**
* Sets the class name of the driver
*
* @param className String
*/
@ConfigProperty(type = String.class, defaultValue = "org.h2.Driver")
@Override
public void setClassName(String className) {
spec.setDetail(DataSourceSpec.CLASSNAME, className);
}
public void setURL(String url) {
spec.setDetail(DataSourceSpec.URL, url);
}
public String getURL() {
return spec.getDetail(DataSourceSpec.URL);
}
/**
* Sets the connection url.
*
* @param url String
* @see getConnectionURL
*/
public void setConnectionURL(String url) {
spec.setDetail(DataSourceSpec.URL, url);
}
/**
* Gets the connection url.
*
* @return url
* @see setConnectionURL
*/
public String getConnectionURL() {
return spec.getDetail(DataSourceSpec.URL);
}
public Object getDataSource() throws ResourceException {
return null;
}
}