org.glassfish.jdbcruntime.JdbcRuntimeExtension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-all Show documentation
Show all versions of payara-embedded-all Show documentation
Payara-Embedded-All Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012 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 [2016] [Payara Foundation]
package org.glassfish.jdbcruntime;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.inject.Inject;
import javax.inject.Provider;
import org.glassfish.jdbc.config.JdbcConnectionPool;
import org.glassfish.jdbc.config.JdbcResource;
import org.glassfish.jdbc.deployer.DataSourceDefinitionDeployer;
import org.glassfish.jdbc.util.JdbcResourcesUtil;
import org.glassfish.jdbc.util.LoggerFactory;
import org.glassfish.jdbcruntime.service.JdbcDataSource;
import org.glassfish.resourcebase.resources.api.PoolInfo;
import org.glassfish.resourcebase.resources.api.ResourceConstants;
import org.glassfish.resourcebase.resources.api.ResourceInfo;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.config.ConfigBeanProxy;
import com.sun.appserv.connectors.internal.api.ConnectorRuntimeException;
import com.sun.appserv.connectors.internal.api.ConnectorsUtil;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.Resource;
import com.sun.enterprise.config.serverbeans.Resources;
import com.sun.enterprise.connectors.ConnectorRuntime;
import com.sun.enterprise.connectors.ConnectorRuntimeExtension;
import com.sun.enterprise.connectors.DeferredResourceConfig;
import com.sun.enterprise.connectors.util.ResourcesUtil;
import com.sun.enterprise.deployment.Application;
/**
* @author Shalini M
*/
@Service
public class JdbcRuntimeExtension implements ConnectorRuntimeExtension {
@Inject
private Provider domainProvider;
@Inject
private Provider dataSourceDefinitionDeployerProvider;
protected final static Logger logger = LoggerFactory.getLogger(JdbcRuntimeExtension.class);
protected ConnectorRuntime runtime;
public JdbcRuntimeExtension() {
runtime = ConnectorRuntime.getRuntime();
}
@Override
public Collection getAllSystemRAResourcesAndPools() {
List resources = new ArrayList();
Domain domain = domainProvider.get();
if(domain !=null) {
Resources allResources = domain.getResources();
for(Resource resource : allResources.getResources()){
if(resource instanceof JdbcConnectionPool){
resources.add(resource);
} else if(resource instanceof JdbcResource){
resources.add(resource);
}
}
}
System.out.println("JdbcRuntimeExtension, getAllSystemRAResourcesAndPools = " + resources);
return resources;
}
@Override
public void registerDataSourceDefinitions(Application application) {
dataSourceDefinitionDeployerProvider.get().registerDataSourceDefinitions(application);
}
@Override
public void unRegisterDataSourceDefinitions(Application application) {
dataSourceDefinitionDeployerProvider.get().unRegisterDataSourceDefinitions(application);
}
/**
* Get a wrapper datasource specified by the jdbcjndi name
* This API is intended to be used in the DAS. The motivation for having this
* API is to provide the CMP backend/ JPA-Java2DB a means of acquiring a connection during
* the codegen phase. If a user is trying to deploy an JPA-Java2DB app on a remote server,
* without this API, a resource reference has to be present both in the DAS
* and the server instance. This makes the deployment more complex for the
* user since a resource needs to be forcibly created in the DAS Too.
* This API will mitigate this need.
*
* @param resourceInfo the jndi name of the resource
* @return DataSource representing the resource.
*/
@Override
public Object lookupDataSourceInDAS(ResourceInfo resourceInfo) throws ConnectorRuntimeException {
JdbcDataSource myDS = new JdbcDataSource();
myDS.setResourceInfo(resourceInfo);
return myDS;
}
/**
* Gets the Pool name that this JDBC resource points to. In case of a PMF resource
* gets the pool name of the pool pointed to by jdbc resource being pointed to by
* the PMF resource
*
* @param resourceInfo the jndi name of the resource being used to get Connection from
* This resource can either be a pmf resource or a jdbc resource
* @return poolName of the pool that this resource directly/indirectly points to
*/
@Override
public PoolInfo getPoolNameFromResourceJndiName(ResourceInfo resourceInfo) {
PoolInfo poolInfo= null;
JdbcResource jdbcResource = null;
String jndiName = resourceInfo.getName();
ResourceInfo actualResourceInfo =
new ResourceInfo(jndiName, resourceInfo.getApplicationName(), resourceInfo.getModuleName());
ConnectorRuntime runtime = ConnectorRuntime.getRuntime();
jdbcResource = (JdbcResource) ConnectorsUtil.getResourceByName(runtime.getResources(actualResourceInfo),
JdbcResource.class, actualResourceInfo.getName());
if(jdbcResource == null){
String suffix = ConnectorsUtil.getValidSuffix(jndiName);
if(suffix != null){
jndiName = jndiName.substring(0, jndiName.lastIndexOf(suffix));
actualResourceInfo =
new ResourceInfo(jndiName, resourceInfo.getApplicationName(), resourceInfo.getModuleName());
}
}
jdbcResource = (JdbcResource) ConnectorsUtil.getResourceByName(runtime.getResources(actualResourceInfo),
JdbcResource.class, actualResourceInfo.getName());
if (jdbcResource != null) {
if (logger.isLoggable(Level.FINE)) {
logger.fine("jdbcRes is ---: " + jdbcResource.getJndiName());
logger.fine("poolName is ---: " + jdbcResource.getPoolName());
}
}
if(jdbcResource != null){
poolInfo = new PoolInfo(jdbcResource.getPoolName(), actualResourceInfo.getApplicationName(),
actualResourceInfo.getModuleName());
}
return poolInfo;
}
/**
* Determines if a JDBC connection pool is referred in a
* server-instance via resource-refs
* @param poolInfo pool-name
* @return boolean true if pool is referred in this server instance as well enabled, false
* otherwise
*/
@Override
public boolean isConnectionPoolReferredInServerInstance(PoolInfo poolInfo) {
Collection jdbcResources = ConnectorRuntime.getRuntime().
getResources(poolInfo).getResources(JdbcResource.class);
for (JdbcResource resource : jdbcResources) {
ResourceInfo resourceInfo = ConnectorsUtil.getResourceInfo(resource);
//Have to check isReferenced here!
if ((resource.getPoolName().equalsIgnoreCase(poolInfo.getName())) &&
ResourcesUtil.createInstance().isReferenced(resourceInfo) &&
ResourcesUtil.createInstance().isEnabled(resource)) {
if (logger.isLoggable(Level.FINE)) {
logger.fine("pool " + poolInfo + "resource " + resourceInfo
+ " referred is referenced by this server");
logger.fine("JDBC resource " + resource.getJndiName() + "refers " + poolInfo
+ "in this server instance and is enabled");
}
return true;
}
}
if(logger.isLoggable(Level.FINE)) {
logger.fine("No JDBC resource refers [ " + poolInfo + " ] in this server instance");
}
return false;
}
@Override
public String getResourceType(ConfigBeanProxy cb) {
if (cb instanceof JdbcConnectionPool) {
return ResourceConstants.RES_TYPE_JCP;
} else if (cb instanceof JdbcResource) {
return ResourceConstants.RES_TYPE_JDBC;
}
return null;
}
@Override
public DeferredResourceConfig getDeferredResourceConfig(Object resource,
Object pool, String resType, String raName)
throws ConnectorRuntimeException {
String resourceAdapterName;
DeferredResourceConfig resConfig = null;
//TODO V3 there should not be res-type related check, refactor deferred-ra-config
//TODO V3 (not to hold specific resource types)
if (resource instanceof JdbcResource || pool instanceof JdbcConnectionPool) {
JdbcConnectionPool jdbcPool = (JdbcConnectionPool) pool;
JdbcResource jdbcResource = (JdbcResource) resource;
resourceAdapterName = getRANameofJdbcConnectionPool((JdbcConnectionPool) pool);
resConfig = new DeferredResourceConfig(resourceAdapterName, null, jdbcPool, jdbcResource, null);
Resource[] resourcesToload = new Resource[]{jdbcPool, jdbcResource};
resConfig.setResourcesToLoad(resourcesToload);
} else {
throw new ConnectorRuntimeException("unsupported resource type : " + resource);
}
return resConfig;
}
/**
* This method takes in an admin JdbcConnectionPool and returns the RA
* that it belongs to.
*
* @param pool - The pool to check
* @return The name of the JDBC RA that provides this pool's data-source
*/
private String getRANameofJdbcConnectionPool(final JdbcConnectionPool pool) {
// singleton, in fact the new instance is created only for the first time.
final JdbcResourcesUtil resourcesUtil = JdbcResourcesUtil.createInstance();
return resourcesUtil.getRANameofJdbcConnectionPool(pool);
}
}