org.glassfish.jdbc.deployer.JdbcResourceDeployer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-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-2021] [Payara Foundation]
package org.glassfish.jdbc.deployer;
import java.util.Collection;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.inject.Inject;
import jakarta.inject.Singleton;
import org.glassfish.jdbc.config.JdbcConnectionPool;
import org.glassfish.jdbc.config.JdbcResource;
import org.glassfish.jdbc.util.JdbcResourcesUtil;
import org.glassfish.jdbc.util.LoggerFactory;
import org.glassfish.resourcebase.resources.api.PoolInfo;
import org.glassfish.resourcebase.resources.api.ResourceConflictException;
import org.glassfish.resourcebase.resources.api.ResourceDeployer;
import org.glassfish.resourcebase.resources.api.ResourceDeployerInfo;
import org.glassfish.resourcebase.resources.api.ResourceInfo;
import org.jvnet.hk2.annotations.Service;
import com.sun.appserv.connectors.internal.api.ConnectorsUtil;
import com.sun.enterprise.config.serverbeans.Application;
import com.sun.enterprise.config.serverbeans.Resource;
import com.sun.enterprise.config.serverbeans.Resources;
import com.sun.enterprise.connectors.ConnectorRegistry;
import com.sun.enterprise.connectors.ConnectorRuntime;
import com.sun.enterprise.util.i18n.StringManager;
/**
* Handles Jdbc resource events in the server instance. When user adds a
* jdbc resource, the admin instance emits resource event. The jdbc
* resource events are propagated to this object.
*
* The methods can potentially be called concurrently, therefore implementation
* need to be synchronized.
*
* @author Nazrul Islam
* @since JDK1.4
*/
@Service
@ResourceDeployerInfo(JdbcResource.class)
@Singleton
public class JdbcResourceDeployer implements ResourceDeployer {
@Inject
private ConnectorRuntime runtime;
private static final StringManager localStrings =
StringManager.getManager(JdbcResourceDeployer.class);
// logger for this deployer
private static Logger _logger = LoggerFactory.getLogger(JdbcResourceDeployer.class);
/**
* {@inheritDoc}
*/
@Override
public synchronized void deployResource(Object resource, String applicationName, String moduleName)
throws Exception {
//deployResource is not synchronized as there is only one caller
//ResourceProxy which is synchronized
JdbcResource jdbcRes = (JdbcResource) resource;
String jndiName = jdbcRes.getJndiName();
String poolName = jdbcRes.getPoolName();
PoolInfo poolInfo = new PoolInfo(poolName, applicationName, moduleName);
ResourceInfo resourceInfo = new ResourceInfo(jndiName, applicationName, moduleName);
runtime.createConnectorResource(resourceInfo, poolInfo, null);
//In-case the resource is explicitly created with a suffix (__nontx or __PM), no need to create one
if (ConnectorsUtil.getValidSuffix(jndiName) == null) {
ResourceInfo pmResourceInfo = new ResourceInfo(ConnectorsUtil.getPMJndiName(jndiName),
resourceInfo.getApplicationName(), resourceInfo.getModuleName());
runtime.createConnectorResource(pmResourceInfo, poolInfo, null);
}
if (_logger.isLoggable(Level.FINEST)) {
_logger.finest("deployed resource " + jndiName);
}
}
/**
* {@inheritDoc}
*/
@Override
public void deployResource(Object resource) throws Exception {
JdbcResource jdbcRes = (JdbcResource) resource;
ResourceInfo resourceInfo = ConnectorsUtil.getResourceInfo(jdbcRes);
deployResource(jdbcRes, resourceInfo.getApplicationName(), resourceInfo.getModuleName());
}
/**
* {@inheritDoc}
*/
@Override
public boolean canDeploy(boolean postApplicationDeployment, Collection allResources, Resource resource) {
if (handles(resource)) {
if (!postApplicationDeployment) {
return true;
}
}
return false;
}
/**
* {@inheritDoc}
*/
@Override
public void undeployResource(Object resource, String applicationName, String moduleName) throws Exception {
JdbcResource jdbcRes = (JdbcResource) resource;
ResourceInfo resourceInfo = new ResourceInfo(jdbcRes.getJndiName(), applicationName, moduleName);
deleteResource(jdbcRes, resourceInfo);
}
/**
* {@inheritDoc}
*/
@Override
public synchronized void undeployResource(Object resource)
throws Exception {
JdbcResource jdbcRes = (JdbcResource) resource;
ResourceInfo resourceInfo = ConnectorsUtil.getResourceInfo(jdbcRes);
deleteResource(jdbcRes, resourceInfo);
}
private void deleteResource(JdbcResource jdbcResource, ResourceInfo resourceInfo) throws Exception {
runtime.deleteConnectorResource(resourceInfo);
ConnectorRegistry.getInstance().removeResourceFactories(resourceInfo);
//In-case the resource is explicitly created with a suffix (__nontx or __PM), no need to delete one
if (ConnectorsUtil.getValidSuffix(resourceInfo.getName()) == null) {
String pmJndiName = ConnectorsUtil.getPMJndiName(resourceInfo.getName());
ResourceInfo pmResourceInfo = new ResourceInfo(pmJndiName, resourceInfo.getApplicationName(),
resourceInfo.getModuleName());
runtime.deleteConnectorResource(pmResourceInfo);
ConnectorRegistry.getInstance().removeResourceFactories(pmResourceInfo);
}
//Since 8.1 PE/SE/EE - if no more resource-ref to the pool
//of this resource in this server instance, remove pool from connector
//runtime
checkAndDeletePool(jdbcResource);
}
/**
* {@inheritDoc}
*/
@Override
public synchronized void redeployResource(Object resource)
throws Exception {
undeployResource(resource);
deployResource(resource);
}
/**
* {@inheritDoc}
*/
@Override
public boolean handles(Object resource) {
return resource instanceof JdbcResource;
}
/**
* @inheritDoc
*/
@Override
public Class[] getProxyClassesForDynamicReconfiguration() {
return new Class[0];
}
/**
* @inheritDoc
*/
@Override
public boolean supportsDynamicReconfiguration() {
return false;
}
/**
* {@inheritDoc}
*/
@Override
public synchronized void enableResource(Object resource) throws Exception {
deployResource(resource);
}
/**
* {@inheritDoc}
*/
@Override
public synchronized void disableResource(Object resource) throws Exception {
undeployResource(resource);
}
/**
* Checks if no more resource-refs to resources exists for the
* JDBC connection pool and then deletes the pool
*
* @param cr Jdbc Resource Config bean
* @throws Exception if unable to access configuration/undeploy resource.
* @since 8.1 pe/se/ee
*/
private void checkAndDeletePool(JdbcResource cr) throws Exception {
String poolName = cr.getPoolName();
ResourceInfo resourceInfo = ConnectorsUtil.getResourceInfo(cr);
PoolInfo poolInfo = new PoolInfo(poolName, resourceInfo.getApplicationName(), resourceInfo.getModuleName());
Resources resources = (Resources) cr.getParent();
//Its possible that the JdbcResource here is a DataSourceDefinition. Ignore optimization.
if (resources != null) {
try {
boolean poolReferred =
JdbcResourcesUtil.createInstance().isJdbcPoolReferredInServerInstance(poolInfo);
if (!poolReferred) {
if (_logger.isLoggable(Level.FINE)) {
_logger.fine("Deleting JDBC pool [" + poolName + " ] as there are no more " +
"resource-refs to the pool in this server instance");
}
JdbcConnectionPool jcp = (JdbcConnectionPool)
ConnectorsUtil.getResourceByName(resources, JdbcConnectionPool.class, poolName);
//Delete/Undeploy Pool
runtime.getResourceDeployer(jcp).undeployResource(jcp);
}
} catch (Exception ce) {
_logger.warning(ce.getMessage());
if (_logger.isLoggable(Level.FINE)) {
_logger.fine("Exception while deleting pool [ " + poolName + " ] : " + ce);
}
throw ce;
}
}
}
/**
* {@inheritDoc}
*/
@Override
public void validatePreservedResource(Application oldApp, Application newApp, Resource resource,
Resources allResources)
throws ResourceConflictException {
//do nothing.
}
}