/*******************************************************************************
* Copyright (c) 1998, 2015 Oracle, IBM Corporation and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation from Oracle TopLink
* 12/18/2014-2.6 Rick Curtis
* - 455690: Move JNDIConnector lookup type to ServerPlatform.
******************************************************************************/
package org.eclipse.persistence.sessions;
import java.util.*;
import java.sql.*;
import javax.naming.*;
import javax.sql.*;
import org.eclipse.persistence.exceptions.*;
import org.eclipse.persistence.internal.helper.*;
import org.eclipse.persistence.internal.localization.*;
/**
* Specifies the J2EE DataSource lookup options.
* This connector is normally used with a login in a J2EE environment
* to connect to a server's connection pool defined by the DataSource name.
* The JNDI name that the DataSource is registered under must be specified,
* this must include any required prefix such as "java:comp/env/", (unless a DataSource object is given).
* A Context is only required if not running on the server, otherwise default to a new InitialContext().
* @author Big Country
* @since TOPLink/Java 2.1
*/
public class JNDIConnector implements Connector {
protected DataSource dataSource;
protected Context context;
protected String name;
protected boolean isCallbackRegistered;
public static final int UNDEFINED_LOOKUP = -1;
public static final int STRING_LOOKUP = 1;
public static final int COMPOSITE_NAME_LOOKUP = 2;
public static final int COMPOUND_NAME_LOOKUP = 3;
@Deprecated
protected int lookupType = UNDEFINED_LOOKUP;
/**
* PUBLIC:
* Construct a Connector with no settings.
* The datasource name will still need to be set.
*/
public JNDIConnector() {
super();
}
/**
* PUBLIC:
* Construct a Connector with the datasource name.
*/
public JNDIConnector(Context context, String name) throws ValidationException {
this(name);
this.context = context;
}
/**
* PUBLIC:
* Construct a Connector with the datasource name.
*/
public JNDIConnector(String name) {
this.name = name;
}
/**
* PUBLIC:
* Construct a Connector with the datasource object.
*/
public JNDIConnector(DataSource dataSource) {
this.dataSource = dataSource;
}
/**
* INTERNAL:
* Clone the connector.
*/
public Object clone() {
try {
return super.clone();
} catch (Exception exception) {
throw new InternalError("Clone failed");
}
}
/**
* INTERNAL:
* Connect with the specified properties and return the Connection.
*/
public Connection connect(Properties properties, Session session) throws DatabaseException, ValidationException {
String user = properties.getProperty("user");
DataSource dataSource = getDataSource();
if (dataSource == null) {
try {
int type = lookupType;
// If lookupType is != UNDEFINED_LOOKUP that means that a user is using the deprecated method yet so
// we need to honor that value.
if(lookupType == UNDEFINED_LOOKUP) {
type = session.getServerPlatform().getJNDIConnectorLookupType();
}
//bug#2761428 and 4405389 JBoss needs to look up datasources based on a string not a composite or compound name
if (type == STRING_LOOKUP) {
dataSource = (DataSource)getContext().lookup(getName());
} else if (type == COMPOSITE_NAME_LOOKUP) {
dataSource = (DataSource)getContext().lookup(new CompositeName(name));
} else {
dataSource = (DataSource)getContext().lookup(new CompoundName(name, new Properties()));
}
this.setDataSource(dataSource);
} catch (NamingException exception) {
throw ValidationException.cannotAcquireDataSource(getName(), exception);
}
}
if (!this.isCallbackRegistered && session.getPlatform().hasPartitioningCallback()) {
session.getPlatform().getPartitioningCallback().register(dataSource, session);
this.isCallbackRegistered = true;
}
try {
// WebLogic connection pools do not require a user name and password.
// JDBCLogin usually initializes these values with an empty string.
// WebLogic data source does not support the getConnection() call with arguments
// it only supports the zero argument call. DM 26/07/2000
if ((user == null) || (user.length() == 0)) {
return dataSource.getConnection();
} else {
Object passwordObject = properties.get("password");
String password = null;
if (passwordObject instanceof char[]) {
password = new String((char[])passwordObject);
} else if (passwordObject instanceof String) {
password = (String) passwordObject;
}
return dataSource.getConnection(user, password);
}
} catch (SQLException exception) {
throw DatabaseException.sqlException(exception, true);
}
}
/**
* PUBLIC:
* Return the JNDI Context that can supplied the named DataSource.
*/
public Context getContext() {
if (context == null) {
try {
context = new InitialContext();
} catch (NamingException exception) {
}
}
return context;
}
/**
* PUBLIC:
* Return the javax.sql.DataSource.
*/
public DataSource getDataSource() {
return dataSource;
}
/**
* PUBLIC:
* Return the name of the DataSource within the
* JNDI Context.
*/
public String getName() {
return name;
}
/**
* PUBLIC:
* Provide the details of my connection information. This is primarily for JMX runtime services.
* @return java.lang.String
*/
public String getConnectionDetails() {
return getName();
}
/**
* PUBLIC:
* Set the JNDI Context that can supply the named DataSource.
*/
public void setContext(Context context) {
this.context = context;
}
/**
* PUBLIC:
* Set the javax.sql.DataSource.
*/
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
/**
* PUBLIC:
* Set the name of the DataSource within the
* JNDI Context.
*/
public void setName(String name) throws ValidationException {
this.name = name;
}
/**
* @deprecated As of 2.6.0, replaced by configuration provided by
* {@link org.eclipse.persistence.platform.server.ServerPlatform#getJNDIConnectorLookupType()}
* @param lookupType
*/
public void setLookupType(int lookupType) {
this.lookupType = lookupType;
}
/**
* @deprecated As of 2.6.0, replaced by configuration provided by
* {@link org.eclipse.persistence.platform.server.ServerPlatform#getJNDIConnectorLookupType()}
*/
public int getLookupType() {
return lookupType;
}
/**
* PUBLIC:
* Print data source info.
*/
public String toString() {
return Helper.getShortClassName(getClass()) + ToStringLocalization.buildMessage("datasource_name", (Object[])null) + "=>" + getName();
}
/**
* INTERNAL:
* Print something useful on the log.
*/
public void toString(java.io.PrintWriter writer) {
writer.print(ToStringLocalization.buildMessage("connector", (Object[])null) + "=>" + Helper.getShortClassName(getClass()));
writer.print(" ");
writer.println(ToStringLocalization.buildMessage("datasource_name", (Object[])null) + "=>" + getName());
}
}