com.sun.appserv.connectors.internal.api.ConnectorsUtil Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 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-2019] Payara Foundation and/or affiliates
package com.sun.appserv.connectors.internal.api;
import com.sun.enterprise.config.serverbeans.*;
import com.sun.enterprise.deploy.shared.FileArchive;
import com.sun.enterprise.deployment.EjbDescriptor;
import com.sun.enterprise.deployment.EjbMessageBeanDescriptor;
import com.sun.enterprise.deployment.EnvironmentProperty;
import com.sun.enterprise.util.io.FileUtils;
import com.sun.logging.LogDomains;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.api.admin.config.ApplicationName;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.connectors.config.*;
import org.glassfish.deployment.common.InstalledLibrariesResolver;
import org.glassfish.deployment.common.JavaEEResourceType;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.Globals;
import org.glassfish.loader.util.ASClassLoaderUtil;
import org.glassfish.resourcebase.resources.api.GenericResourceInfo;
import org.glassfish.resourcebase.resources.api.PoolInfo;
import org.glassfish.resourcebase.resources.api.ResourceConstants;
import org.glassfish.resourcebase.resources.api.ResourceInfo;
import org.glassfish.resourcebase.resources.util.ResourceUtil;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import java.io.*;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.sql.Connection;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import static com.sun.enterprise.util.SystemPropertyConstants.SLASH;
/**
* Util class for connector related classes
*/
public class ConnectorsUtil {
private static Logger _logger= LogDomains.getLogger(ConnectorsUtil.class, LogDomains.RSR_LOGGER);
private static Collection validSystemRARs = new HashSet();
private static Collection validNonJdbcSystemRARs = new HashSet();
static{
initializeSystemRars();
initializeNonJdbcSystemRars();
}
/**
* determine whether the RAR in question is a System RAR
* @param raName RarName
* @return boolean
*/
public static boolean belongsToSystemRA(String raName) {
boolean result = false;
for (String systemRarName : ConnectorsUtil.getSystemRARs()) {
if (systemRarName.equals(raName)) {
result = true;
break;
}
}
return result;
}
public static boolean getPingDuringPoolCreation(PoolInfo poolInfo, Resources allResources) {
ResourcePool pool = getConnectionPoolConfig(poolInfo, allResources);
return pool != null && Boolean.parseBoolean(pool.getPing());
}
/**
* determine whether the RAR in question is a System RAR
* @param raName RarName
* @return boolean
*/
public static boolean belongsToJdbcRA(String raName) {
boolean result = false;
for (String systemRarName : ConnectorConstants.jdbcSystemRarNames) {
if (systemRarName.equals(raName)) {
result = true;
break;
}
}
return result;
}
/**
* get the installation directory of System RARs
* @param moduleName RARName
* @return directory location
*/
public static String getSystemModuleLocation(String moduleName) {
String j2eeModuleDirName = System.getProperty(ConnectorConstants.INSTALL_ROOT) +
File.separator + "lib" +
File.separator + "install" +
File.separator + "applications" +
File.separator + moduleName;
return j2eeModuleDirName;
}
private static ConfigBeansUtilities getConfigBeansUtilities() {
ServiceLocator locator = Globals.getDefaultHabitat();
if (locator == null) return null;
return locator.getService(ConfigBeansUtilities.class);
}
private static String internalGetLocation(String moduleName) {
ConfigBeansUtilities cbu = getConfigBeansUtilities();
if (cbu == null) return null;
return cbu.getLocation(moduleName);
}
public static String getLocation(String moduleName) throws ConnectorRuntimeException {
String location = null;
if(ConnectorsUtil.belongsToSystemRA(moduleName)){
location = ConnectorsUtil.getSystemModuleLocation(moduleName);
}else{
location = internalGetLocation(moduleName);
if(location == null){
//check whether its embedded RAR
String rarName = getRarNameFromApplication(moduleName);
String appName = getApplicationNameOfEmbeddedRar(moduleName);
if(appName != null && rarName != null){
location = internalGetLocation(appName);
if(location != null){
location = location + File.separator + rarName + "_rar";
}else{
throw new ConnectorRuntimeException("Unable to find location for module : " + moduleName);
}
}
}
}
return location;
/* TODO V3
if(moduleName == null) {
return null;
}
String location = null;
ConnectorModule connectorModule =
dom.getApplications().getConnectorModuleByName(moduleName);
if(connectorModule != null) {
location = RelativePathResolver.
resolvePath(connectorModule.getLocation());
}
return location;
*/
}
/**
* Return the system PM name for the JNDI name
* @param jndiName jndi name
* @return String jndi name for PM resource
**/
public static String getPMJndiName( String jndiName ) {
return jndiName + ConnectorConstants.PM_JNDI_SUFFIX;
}
/**
* check whether the jndi Name has connector related suffix and return if any.
* @param name jndi name
* @return suffix, if found
*/
public static String getValidSuffix(String name) {
if (name != null) {
for (String validSuffix : ConnectorConstants.JNDI_SUFFIX_VALUES) {
if (name.endsWith(validSuffix)) {
return validSuffix;
}
}
}
return null;
}
/**
* If the suffix is one of the valid context return true.
* Return false, if that is not the case.
*
* @param suffix __nontx / __pm
* @return boolean whether the suffix is valid or not
*/
public static boolean isValidJndiSuffix(String suffix) {
if (suffix != null) {
for (String validSuffix : ConnectorConstants.JNDI_SUFFIX_VALUES) {
if (validSuffix.equals(suffix)) {
return true;
}
}
}
return false;
}
/**
* Given the name of the resource and its jndi env, derive the complete jndi name. (eg; with __PM / __nontx)
* @param name name of the resource
* @param env env
* @return derived name
*/
public static String deriveJndiName(String name, Hashtable env) {
String suffix = (String) env.get(ConnectorConstants.JNDI_SUFFIX_PROPERTY);
if (ConnectorsUtil.isValidJndiSuffix(suffix)) {
return name + suffix;
}
return name;
}
public static ResourcePool getConnectionPoolConfig(PoolInfo poolInfo, Resources allResources){
ResourcePool pool = null;
for(Resource configuredResource : allResources.getResources()){
if(configuredResource instanceof ResourcePool){
ResourcePool resourcePool= (ResourcePool)configuredResource;
if(resourcePool.getName().equals(poolInfo.getName())){
pool = resourcePool;
break;
}
}
}
return pool;
}
public static Collection getAllResources(Collection poolNames, Resources allResources) {
List connectorResources = new ArrayList();
for(Resource resource : allResources.getResources()){
if(resource instanceof ConnectorResource){
ConnectorResource connectorResource = (ConnectorResource)resource;
if(poolNames.contains(connectorResource.getPoolName())){
connectorResources.add(connectorResource);
}
}
}
return connectorResources;
}
/**
* get the list of pool names
* @param connectionPools list of pools
* @return list of pol names
*/
public static Collection getAllPoolNames(Collection connectionPools) {
Set poolNames = new HashSet();
for(ConnectorConnectionPool pool : connectionPools){
poolNames.add(pool.getName());
}
return poolNames;
}
public static Collection getAllWorkSecurityMaps(Resources resources, String moduleName){
List workSecurityMaps = new ArrayList();
for(WorkSecurityMap resource : resources.getResources(WorkSecurityMap.class)){
if(resource.getResourceAdapterName().equals(moduleName)){
workSecurityMaps.add(resource);
}
}
return workSecurityMaps;
}
/**
* get the pools for a particular resource-adapter
* @param moduleName resource-adapter name
* @return collection of connectorConnectionPool
*/
public static Collection getAllPoolsOfModule(String moduleName, Resources allResources) {
List connectorConnectionPools = new ArrayList();
for(Resource resource : allResources.getResources()){
if(resource instanceof ConnectorConnectionPool){
ConnectorConnectionPool connectorConnectionPool = (ConnectorConnectionPool)resource;
if(connectorConnectionPool.getResourceAdapterName().equals(moduleName)){
connectorConnectionPools.add(connectorConnectionPool);
}
}
}
return connectorConnectionPools;
}
/**
* Get all System RAR pools and resources
* @param allResources all configured resources
* @return Collection of system RAR pools
*/
public static Collection getAllSystemRAResourcesAndPools(Resources allResources) {
//Make sure that resources are added first and then pools.
List resources = new ArrayList();
List pools = new ArrayList();
for(Resource resource : allResources.getResources()){
if( resource instanceof ConnectorConnectionPool){
String raName = ((ConnectorConnectionPool)resource).getResourceAdapterName();
if( ConnectorsUtil.belongsToSystemRA(raName) ){
pools.add(resource);
}
} else if( resource instanceof ConnectorResource){
String poolName = ((ConnectorResource)resource).getPoolName();
String raName = getResourceAdapterNameOfPool(poolName, allResources);
if( ConnectorsUtil.belongsToSystemRA(raName) ){
resources.add(resource);
}
} else if (resource instanceof AdminObjectResource){ // jms-ra
String raName = ((AdminObjectResource)resource).getResAdapter();
if(ConnectorsUtil.belongsToSystemRA(raName)){
resources.add(resource);
}
} //no need to list work-security-map as they are not deployable artifacts
}
resources.addAll(pools);
return resources;
}
/**
* Given the poolname, retrieve the resourceadapter name
* @param poolName connection pool name
* @param allResources resources
* @return resource-adapter name
*/
public static String getResourceAdapterNameOfPool(String poolName, Resources allResources) {
String raName = null;
for(Resource resource : allResources.getResources()){
if(resource instanceof ConnectorConnectionPool){
ConnectorConnectionPool ccp = (ConnectorConnectionPool)resource;
String name = ccp.getName();
if(name.equalsIgnoreCase(poolName)){
raName = ccp.getResourceAdapterName();
break;
}
}
}
return raName;
}
public static ResourceAdapterConfig getRAConfig(String raName, Resources allResources) {
Collection raConfigs = allResources.getResources(ResourceAdapterConfig.class);
for(ResourceAdapterConfig rac : raConfigs){
if(rac.getResourceAdapterName().equals(raName)){
return rac;
}
}
return null;
}
/**
* given the ra-name, returns all the configured connector-work-security-maps for the .rar
* @param raName resource-adapter name
* @param allResources resources
* @return list of work-security-maps
*/
public static List getWorkSecurityMaps(String raName, Resources allResources){
List resourcesList = allResources.getResources();
List workSecurityMaps = new ArrayList();
for(Resource resource : resourcesList){
if(resource instanceof WorkSecurityMap){
WorkSecurityMap wsm = (WorkSecurityMap)resource;
if(wsm.getResourceAdapterName().equals(raName)){
workSecurityMaps.add(wsm);
}
}
}
return workSecurityMaps;
}
public static boolean isDynamicReconfigurationEnabled(ResourcePool pool){
boolean enabled = false;
if(pool instanceof PropertyBag){
PropertyBag properties = (PropertyBag)pool;
Property property = properties.getProperty(ConnectorConstants.DYNAMIC_RECONFIGURATION_FLAG);
if(property != null){
try{
if(Long.parseLong(property.getValue()) > 0){
enabled = true;
}
}catch(NumberFormatException nfe){
_logger.log(Level.WARNING, "invalid.dynamic-reconfig.value", property.getValue());
}
}
}
return enabled;
}
/**
* Prepares the name/value pairs for ActivationSpec.
* Rule:
* 1. The name/value pairs are the union of activation-config on
* standard DD (message-driven) and runtime DD (mdb-resource-adapter)
* 2. If there are duplicate property settings, the value in runtime
* activation-config will overwrite the one in the standard
* activation-config.
*/
public static Set getMergedActivationConfigProperties(EjbMessageBeanDescriptor msgDesc) {
Set mergedProps = new HashSet();
Set runtimePropNames = new HashSet();
Set runtimeProps = msgDesc.getRuntimeActivationConfigProperties();
if (runtimeProps != null) {
Iterator iter = runtimeProps.iterator();
while (iter.hasNext()) {
EnvironmentProperty entry = (EnvironmentProperty) iter.next();
mergedProps.add(entry);
String propName = entry.getName();
runtimePropNames.add(propName);
}
}
Set standardProps = msgDesc.getActivationConfigProperties();
if (standardProps != null) {
Iterator iter = standardProps.iterator();
while (iter.hasNext()) {
EnvironmentProperty entry = (EnvironmentProperty) iter.next();
String propName = entry.getName();
if (runtimePropNames.contains(propName))
continue;
mergedProps.add(entry);
}
}
return mergedProps;
}
public static boolean isJMSRA(String moduleName) {
if(ConnectorConstants.DEFAULT_JMS_ADAPTER.equals(moduleName)){
return true;
}
return false;
}
public static boolean parseBoolean(String enabled) {
return Boolean.parseBoolean(enabled);
}
/**
* Gets the shutdown-timeout attribute from domain.xml
* via the connector server config bean.
* @param connectorService connector-service configuration
* @return long shutdown timeout (in mill-seconds)
*/
public static long getShutdownTimeout(ConnectorService connectorService) {
int shutdownTimeout;
try {
if (connectorService == null) {
//Connector service element is not specified in
//domain.xml and hence going with the default time-out
shutdownTimeout =
ConnectorConstants.DEFAULT_RESOURCE_ADAPTER_SHUTDOWN_TIMEOUT;
if(_logger.isLoggable(Level.FINE)) {
_logger.log(Level.FINE, "Shutdown timeout set to "+ shutdownTimeout + " through default");
}
} else {
shutdownTimeout = Integer.parseInt(connectorService.getShutdownTimeoutInSeconds());
if(_logger.isLoggable(Level.FINE)) {
_logger.log(Level.FINE, "Shutdown timeout set to " + shutdownTimeout + " from domain.xml");
}
}
} catch (Exception e) {
_logger.log(Level.WARNING, "error_reading_connectorservice_elt", e);
//Going ahead with the default timeout value
shutdownTimeout = ConnectorConstants.DEFAULT_RESOURCE_ADAPTER_SHUTDOWN_TIMEOUT;
}
return shutdownTimeout * 1000L;
}
/**
* Provides the list of built in custom resources by
* resource-type and factory-class-name pair.
* @return map of resource-type & factory-class-name
*/
public static Map getBuiltInCustomResources(){
Map resourcesMap = new HashMap();
// user will have to provide the JavaBean Implementation class and hence we cannot list this factory
// resourcesMap.put("JavaBean", ConnectorConstants.JAVA_BEAN_FACTORY_CLASS );
resourcesMap.put("java.lang.Integer", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Long", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Double", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Float", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Character", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Short", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Byte", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.Boolean", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.lang.String", ConnectorConstants.PRIMITIVES_AND_STRING_FACTORY_CLASS );
resourcesMap.put("java.net.URL", ConnectorConstants.URL_OBJECTS_FACTORY );
resourcesMap.put("java.util.Properties", ConnectorConstants.PROPERTIES_FACTORY );
return resourcesMap;
}
public static String getTransactionIsolationInt(int tranIsolation) {
switch (tranIsolation) {
case Connection.TRANSACTION_READ_UNCOMMITTED:
return "read-uncommited";
case Connection.TRANSACTION_READ_COMMITTED:
return "read-committed";
case Connection.TRANSACTION_REPEATABLE_READ:
return "repeatable-read";
case Connection.TRANSACTION_SERIALIZABLE:
return "serializable";
case fish.payara.sql.Connection.TRANSACTION_SNAPSHOT:
return "snapshot";
default:
throw new RuntimeException("Invalid transaction isolation; the transaction "
+ "isolation level can be empty or any of the following: "
+ "read-uncommitted, read-committed, repeatable-read, serializable");
}
}
public static String deriveResourceName(String compId, String name, JavaEEResourceType resType) {
String derivedName = name;
return getReservePrefixedJNDINameForResource(compId, derivedName, resType);
}
public static String getReservePrefixedJNDINameForResource(String compId, String resourceName, JavaEEResourceType resType) {
String prefix = null;
String prefixPart1 = null;
String prefixPart2 = null;
if(resType!=null) {
switch (resType) {
case DSD :
prefixPart1 = ConnectorConstants.RESOURCE_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.DATASOURCE_DEFINITION_JNDINAME_PREFIX;
break;
case MSD :
prefixPart1 = ConnectorConstants.RESOURCE_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.MAILSESSION_DEFINITION_JNDINAME_PREFIX;
break;
case CFD :
prefixPart1 = ConnectorConstants.RESOURCE_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.CONNECTION_FACTORY_DEFINITION_JNDINAME_PREFIX;
break;
case DSDPOOL:
prefixPart1 = ConnectorConstants.POOLS_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.DATASOURCE_DEFINITION_JNDINAME_PREFIX;
break;
case CFDPOOL:
prefixPart1 = ConnectorConstants.POOLS_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.CONNECTION_FACTORY_DEFINITION_JNDINAME_PREFIX;
break;
case JMSCFDD:
prefixPart1 = ConnectorConstants.RESOURCE_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.JMS_CONNECTION_FACTORY_DEFINITION_JNDINAME_PREFIX;
break;
case JMSCFDDPOOL:
prefixPart1 = ConnectorConstants.POOLS_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.JMS_CONNECTION_FACTORY_DEFINITION_JNDINAME_PREFIX;
break;
case JMSDD:
prefixPart1 = ConnectorConstants.RESOURCE_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.JMS_DESTINATION_DEFINITION_JNDINAME_PREFIX;
break;
case AODD:
prefixPart1 = ConnectorConstants.RESOURCE_JNDINAME_PREFIX;
prefixPart2 = ConnectorConstants.ADMINISTERED_OBJECT_DEFINITION_JNDINAME_PREFIX;
break;
}
}
if(compId == null || compId.equals("")){
prefix = prefixPart1 + prefixPart2;
}else{
prefix = prefixPart1 + prefixPart2 + compId +"/";
}
return getReservePrefixedJNDIName(prefix, resourceName);
}
public static Map convertPropertiesToMap(Properties properties){
if(properties == null){
properties = new Properties();
}
return new TreeMap((Map) properties);
}
private static String getReservePrefixedJNDIName(String prefix, String resourceName) {
return prefix + resourceName;
}
public static String getEmbeddedRarModuleName(String applicationName, String moduleName) {
String embeddedRarName = moduleName.substring(0,
moduleName.indexOf(ConnectorConstants.EXPLODED_EMBEDDED_RAR_EXTENSION));
moduleName = applicationName + ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER + embeddedRarName;
return moduleName;
}
public static String getApplicationNameOfEmbeddedRar(String embeddedRarName) {
int index = embeddedRarName.indexOf(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER);
String applicationName = embeddedRarName;
if(index != -1){
applicationName = embeddedRarName.substring(0,index);
}
return applicationName;
}
public static String getRarNameFromApplication(String appName) {
int index = appName.indexOf(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER);
String rarName = appName;
if(index != -1 && appName.length() > index+1){
rarName = appName.substring(index+1);
}
return rarName;
}
public static boolean isEmbedded(DeploymentContext context) {
ReadableArchive archive = context.getSource();
return (archive != null && archive.getParentArchive() != null);
}
public static String getApplicationName(DeploymentContext context) {
String applicationName = null;
ReadableArchive parentArchive = context.getSource().getParentArchive();
if (parentArchive != null) {
applicationName = parentArchive.getName();
}else{
applicationName = context.getSource().getName();
}
return applicationName;
}
public static List getInstalledLibrariesFromManifest(String moduleDirectory, ServerEnvironment env)
throws ConnectorRuntimeException {
// this method will be called during system-rar creation.
// Though there are code paths that will call this method for creation of rars during recovery / via
// API exposed for GUI, they will not call this method as non-system rars are always started during server startup
// system-rars can specify only EXTENSTION_LIST in MANIFEST.MF and do not have a way to use --libraries option.
// So, satisfying system-rars alone as of now.
List libURIs = new ArrayList();
if(moduleDirectory != null){
try {
File module = new File(moduleDirectory);
if (module.exists()) {
FileArchive fileArchive = new FileArchive();
fileArchive.open(module.toURI()); // directory where rar is exploded
Set extensionList = InstalledLibrariesResolver.getInstalledLibraries(fileArchive);
URL[] extensionListLibraries = ASClassLoaderUtil.getLibrariesAsURLs(extensionList, env);
for (URL url : extensionListLibraries) {
libURIs.add(url.toURI());
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "adding URL [ " + url + " ] to installedLibraries");
}
}
}
} catch (IOException ioe) {
ConnectorRuntimeException cre = new ConnectorRuntimeException(ioe.getMessage());
cre.initCause(ioe);
throw cre;
} catch (URISyntaxException e) {
ConnectorRuntimeException cre = new ConnectorRuntimeException(e.getMessage());
cre.initCause(e);
throw cre;
}
}
return libURIs;
}
public static String getReservePrefixedJNDINameForDescriptor(String moduleName) {
return getReservePrefixedJNDIName(ConnectorConstants.DD_PREFIX, moduleName);
}
public static boolean isStandAloneRA(String moduleName){
ConfigBeansUtilities cbu = getConfigBeansUtilities();
ApplicationName an = null;
if (cbu != null) {
an = cbu.getModule(moduleName);
}
return (an != null);
}
public static Collection getSystemRARs() {
return validSystemRARs;
}
private static void initializeSystemRars() {
for (String rarName : ConnectorConstants.systemRarNames) {
if (systemRarExists(getSystemModuleLocation(rarName))) {
validSystemRARs.add(rarName);
}
}
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "valid system RARs for this runtime are : " + validSystemRARs);
}
}
public static Collection getNonJdbcSystemRars() {
return validNonJdbcSystemRARs;
}
private static void initializeNonJdbcSystemRars() {
Collection systemRars = getSystemRARs();
for (String rarName : systemRars) {
if (!ConnectorConstants.jdbcSystemRarNames.contains(rarName)) {
validNonJdbcSystemRARs.add(rarName);
}
}
}
public static boolean systemRarExists(String location){
boolean result = false;
try{
File file = new File(location);
result = file.exists();
}catch(Exception e){
if(_logger.isLoggable(Level.FINEST)){
_logger.log(Level.FINEST, "Exception occurred while checking System RAR location " +
": [" + location + "]", e);
}
}
return result;
}
/**
* GlassFish (Embedded) Uber jar will have .rar bundled in it.
* This method will extract the .rar from the uber jar into specified directory.
* As of now, this method is only used in EMBEDDED mode
* @param fileName rar-directory-name
* @param rarName resource-adapter name
* @param destDir destination directory
* @return status indicating whether .rar is exploded successfully or not
*/
public static boolean extractRar(String fileName, String rarName, String destDir) {
InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(rarName);
if (is != null) {
FileArchive fa = new FileArchive();
OutputStream os = null;
try {
os = fa.putNextEntry(fileName);
FileUtils.copy(is, os, 0);
} catch (IOException e) {
Object args[] = new Object[]{rarName, e};
_logger.log(Level.WARNING, "error.extracting.archive", args);
return false;
} finally {
try {
if (os != null) {
fa.closeEntry();
}
} catch (IOException ioe) {
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "Exception while closing archive [ " + fileName + " ]", ioe);
}
}
try {
is.close();
} catch (IOException ioe) {
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "Exception while closing archive [ " + rarName + " ]", ioe);
}
}
}
File file = new File(fileName);
if (file.exists()) {
try {
extractJar(file, destDir);
} catch (Exception e) {
e.printStackTrace();
}
return true;
} else {
_logger.log(Level.INFO, "could not find RAR [ " + rarName + " ] location [ " + fileName + " ] " +
"after extraction");
return false;
}
} else {
_logger.log(Level.INFO, "could not find RAR [ " + rarName + " ] in the archive, skipping .rar extraction");
return false;
}
}
private static void extractJar(File jarFile, String destDir) throws IOException {
java.util.jar.JarFile jar = new java.util.jar.JarFile(jarFile);
java.util.Enumeration enum1 = jar.entries();
try{
while (enum1.hasMoreElements()) {
java.util.jar.JarEntry file = (java.util.jar.JarEntry) enum1.nextElement();
java.io.File f = new java.io.File(destDir + java.io.File.separator + file.getName());
if (file.isDirectory()) {
f.mkdir();
continue;
}
InputStream is = null;
FileOutputStream fos = null;
try {
is = jar.getInputStream(file);
fos = new FileOutputStream(f);
while (is.available() > 0) {
fos.write(is.read());
}
} finally {
try {
if (fos != null) {
fos.close();
}
} catch (Exception e) {
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "exception while closing archive [ " + f.getName() + " ]", e);
}
}
try {
if (is != null) {
is.close();
}
} catch (Exception e) {
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "exception while closing archive [ " + file.getName() + " ]", e);
}
}
}
}
}finally{
try {
jar.close();
} catch (Exception e) {
if (_logger.isLoggable(Level.FINEST)) {
_logger.log(Level.FINEST, "exception while closing archive [ " + jar.getName() + " ]", e);
}
}
}
}
public static PoolInfo getPoolInfo(ResourcePool resource){
return ResourceUtil.getPoolInfo(resource);
}
public static ResourceInfo getResourceInfo(BindableResource resource){
return org.glassfish.resourcebase.resources.util.ResourceUtil.getResourceInfo(resource);
}
public static String getApplicationName(Resource resource){
String applicationName = null;
if(resource.getParent() != null && resource.getParent().getParent() instanceof Application){
Application application = (Application)resource.getParent().getParent();
applicationName = application.getName();
}
return applicationName;
}
public static String getApplicationName(PoolInfo poolInfo){
return poolInfo.getApplicationName();
}
public static boolean isApplicationScopedResource(GenericResourceInfo resourceInfo){
return org.glassfish.resourcebase.resources.util.ResourceUtil.isApplicationScopedResource(resourceInfo);
}
public static boolean isModuleScopedResource(GenericResourceInfo resourceInfo){
return ResourceUtil.isModuleScopedResource(resourceInfo);
}
public static String escapeResourceNameForMonitoring(String name){
return name.replaceAll("/", SLASH);
}
public static String getPoolMonitoringSubTreeRoot(PoolInfo poolInfo, boolean escapeSlashes) {
String resourcesPrefix = "resources/";
String suffix = poolInfo.getName();
if(escapeSlashes){
suffix = escapeResourceNameForMonitoring(suffix);
}
String subTreeRoot = resourcesPrefix + suffix;
if(ConnectorsUtil.isModuleScopedResource(poolInfo)){
subTreeRoot = "applications/" + poolInfo.getApplicationName()+ "/" + poolInfo.getModuleName() + "/" +
resourcesPrefix + "/" + suffix;
}else if(ConnectorsUtil.isApplicationScopedResource(poolInfo)){
subTreeRoot = "applications/" + poolInfo.getApplicationName() + "/" + resourcesPrefix + "/" + suffix;
}
return subTreeRoot;
}
public static String getActualModuleName(String moduleName){
return ResourceUtil.getActualModuleName(moduleName);
}
public static String getModuleName(EjbDescriptor descriptor) {
String appName = descriptor.getApplication().getAppName();
String moduleName = descriptor.getEjbBundleDescriptor().getModuleID();
String actualModuleName = moduleName;
if(moduleName != null){
String prefix = appName+"#";
if(moduleName.startsWith(prefix)){
actualModuleName = moduleName.substring(prefix.length());
}
}
return actualModuleName;
}
public static Collection getResourcesOfPool(Resources resources, String connectionPoolName) {
Set resourcesReferringPool = new HashSet();
ResourcePool pool = (ResourcePool) getResourceByName(resources, ResourcePool.class, connectionPoolName);
if (pool != null) {
Collection bindableResources = resources.getResources(BindableResource.class);
for (BindableResource resource : bindableResources) {
if (ResourcePoolReference.class.isAssignableFrom(resource.getClass())) {
if ((((ResourcePoolReference) resource).getPoolName()).equals(connectionPoolName)) {
resourcesReferringPool.add(resource);
}
}
}
}
return resourcesReferringPool;
}
public static Resource getResourceByName(Resources resources, Class type, String name) {
return resources.getResourceByName(type, name);
}
//TODO what if the module being deployed is a RAR and has gf-resources.xml ?
//TODO can the RAR define its own resources ? eg: connector-resource, pool, a-o-r ?
public static ResourceConstants.TriState
isEmbeddedRarResource(Resource configBeanResource,
Collection configBeanResources) {
ConnectorConstants.TriState result = ConnectorConstants.TriState.FALSE;
if(configBeanResource instanceof ConnectorResource){
String poolName = ((ConnectorResource)configBeanResource).getPoolName();
ConnectorConnectionPool pool = getPool(configBeanResources, poolName);
if(pool != null){
if(pool.getResourceAdapterName().contains(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER)){
result = ConnectorConstants.TriState.TRUE;
}
}else{
result = ConnectorConstants.TriState.UNKNOWN;
}
}else if(configBeanResource instanceof AdminObjectResource){
AdminObjectResource aor = (AdminObjectResource)configBeanResource;
if(aor.getResAdapter().contains(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER)){
result = ConnectorConstants.TriState.TRUE;
}
}else if (configBeanResource instanceof ConnectorConnectionPool){
ConnectorConnectionPool ccp = (ConnectorConnectionPool)configBeanResource;
if(ccp.getResourceAdapterName().contains(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER)){
result = ConnectorConstants.TriState.TRUE;
}
}else if (configBeanResource instanceof WorkSecurityMap){
WorkSecurityMap wsm = (WorkSecurityMap)configBeanResource;
if(wsm.getResourceAdapterName().contains(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER)){
result = ConnectorConstants.TriState.TRUE;
}
}/*else if (configBeanResource instanceof ResourceAdapterConfig){
ResourceAdapterConfig rac = (ResourceAdapterConfig)configBeanResource;
result = rac.getResourceAdapterName().contains(ConnectorConstants.EMBEDDEDRAR_NAME_DELIMITER);
}*/
return result;
}
public static ConnectorConnectionPool getPool(
Collection configBeanResources, String poolName) {
ConnectorConnectionPool result = null;
for(Resource res : configBeanResources){
if(res instanceof ConnectorConnectionPool){
if(((ConnectorConnectionPool)res).getName().equals(poolName)){
result = (ConnectorConnectionPool)res;
break;
}
}
}
return result;
}
public static boolean isRARResource(Resource resource){
return resource instanceof ConnectorResource ||
resource instanceof AdminObjectResource ||
resource instanceof ConnectorConnectionPool ||
resource instanceof ResourceAdapterConfig ||
resource instanceof WorkSecurityMap;
}
public static String getRarNameOfResource(Resource resource, Resources resources){
String rarName = null;
if(isRARResource(resource)){
if(resource instanceof ConnectorResource){
String poolName = ((ConnectorResource)resource).getPoolName();
for(Resource res : resources.getResources()){
if(res instanceof ConnectorConnectionPool){
ConnectorConnectionPool ccp = ((ConnectorConnectionPool)res);
if(ccp.getName().equals(poolName)){
return ccp.getResourceAdapterName();
}
}
}
}else if (resource instanceof ConnectorConnectionPool){
ConnectorConnectionPool ccp = ((ConnectorConnectionPool)resource);
return ccp.getResourceAdapterName();
}else if (resource instanceof AdminObjectResource){
AdminObjectResource aor = (AdminObjectResource)resource;
return aor.getResAdapter();
}else if (resource instanceof ResourceAdapterConfig){
ResourceAdapterConfig rac = (ResourceAdapterConfig)resource;
return rac.getResourceAdapterName();
}else if (resource instanceof WorkSecurityMap){
WorkSecurityMap wsm = (WorkSecurityMap)resource;
return wsm.getResourceAdapterName();
}
}
return rarName;
}
}