com.sun.appserv.connectors.internal.api

Class ConnectorsUtil

java.lang.Object

com.sun.appserv.connectors.internal.api.ConnectorsUtil

public class ConnectorsUtil
extends Object

Util class for connector related classes

Constructor Summary

Constructors

Constructor and Description
ConnectorsUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	belongsToJdbcRA(String raName) determine whether the RAR in question is a System RAR
static boolean	belongsToSystemRA(String raName) determine whether the RAR in question is a System RAR
static Map<String,String>	convertPropertiesToMap(Properties properties)
static String	deriveJndiName(String name, Hashtable env) Given the name of the resource and its jndi env, derive the complete jndi name.
static String	deriveResourceName(String compId, String name, org.glassfish.deployment.common.JavaEEResourceType resType)
static String	escapeResourceNameForMonitoring(String name)
static boolean	extractRar(String fileName, String rarName, String destDir) GlassFish (Embedded) Uber jar will have .rar bundled in it.
static String	getActualModuleName(String moduleName)
static Collection<String>	getAllPoolNames(Collection<ConnectorConnectionPool> connectionPools) get the list of pool names
static Collection<ConnectorConnectionPool>	getAllPoolsOfModule(String moduleName, com.sun.enterprise.config.serverbeans.Resources allResources) get the pools for a particular resource-adapter
static Collection<com.sun.enterprise.config.serverbeans.Resource>	getAllResources(Collection<String> poolNames, com.sun.enterprise.config.serverbeans.Resources allResources)
static Collection<com.sun.enterprise.config.serverbeans.Resource>	getAllSystemRAResourcesAndPools(com.sun.enterprise.config.serverbeans.Resources allResources) Get all System RAR pools and resources
static Collection<WorkSecurityMap>	getAllWorkSecurityMaps(com.sun.enterprise.config.serverbeans.Resources resources, String moduleName)
static String	getApplicationName(org.glassfish.api.deployment.DeploymentContext context)
static String	getApplicationName(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo)
static String	getApplicationName(com.sun.enterprise.config.serverbeans.Resource resource)
static String	getApplicationNameOfEmbeddedRar(String embeddedRarName)
static Map<String,String>	getBuiltInCustomResources() Provides the list of built in custom resources by resource-type and factory-class-name pair.
static com.sun.enterprise.config.serverbeans.ResourcePool	getConnectionPoolConfig(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo, com.sun.enterprise.config.serverbeans.Resources allResources)
static String	getEmbeddedRarModuleName(String applicationName, String moduleName)
static List<URI>	getInstalledLibrariesFromManifest(String moduleDirectory, org.glassfish.api.admin.ServerEnvironment env)
static String	getLocation(String moduleName)
static Set	getMergedActivationConfigProperties(com.sun.enterprise.deployment.EjbMessageBeanDescriptor msgDesc) Prepares the name/value pairs for ActivationSpec.
static String	getModuleName(com.sun.enterprise.deployment.EjbDescriptor descriptor)
static Collection<String>	getNonJdbcSystemRars()
static boolean	getPingDuringPoolCreation(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo, com.sun.enterprise.config.serverbeans.Resources allResources)
static String	getPMJndiName(String jndiName) Return the system PM name for the JNDI name
static ConnectorConnectionPool	getPool(Collection<com.sun.enterprise.config.serverbeans.Resource> configBeanResources, String poolName)
static org.glassfish.resourcebase.resources.api.PoolInfo	getPoolInfo(com.sun.enterprise.config.serverbeans.ResourcePool resource)
static String	getPoolMonitoringSubTreeRoot(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo, boolean escapeSlashes)
static ResourceAdapterConfig	getRAConfig(String raName, com.sun.enterprise.config.serverbeans.Resources allResources)
static String	getRarNameFromApplication(String appName)
static String	getRarNameOfResource(com.sun.enterprise.config.serverbeans.Resource resource, com.sun.enterprise.config.serverbeans.Resources resources)
static String	getReservePrefixedJNDINameForDescriptor(String moduleName)
static String	getReservePrefixedJNDINameForResource(String compId, String resourceName, org.glassfish.deployment.common.JavaEEResourceType resType)
static String	getResourceAdapterNameOfPool(String poolName, com.sun.enterprise.config.serverbeans.Resources allResources) Given the poolname, retrieve the resourceadapter name
static <T> com.sun.enterprise.config.serverbeans.Resource	getResourceByName(com.sun.enterprise.config.serverbeans.Resources resources, Class<T> type, String name)
static org.glassfish.resourcebase.resources.api.ResourceInfo	getResourceInfo(com.sun.enterprise.config.serverbeans.BindableResource resource)
static Collection<com.sun.enterprise.config.serverbeans.BindableResource>	getResourcesOfPool(com.sun.enterprise.config.serverbeans.Resources resources, String connectionPoolName)
static long	getShutdownTimeout(ConnectorService connectorService) Gets the shutdown-timeout attribute from domain.xml via the connector server config bean.
static String	getSystemModuleLocation(String moduleName) get the installation directory of System RARs
static Collection<String>	getSystemRARs()
static String	getTransactionIsolationInt(int tranIsolation)
static String	getValidSuffix(String name) check whether the jndi Name has connector related suffix and return if any.
static List<WorkSecurityMap>	getWorkSecurityMaps(String raName, com.sun.enterprise.config.serverbeans.Resources allResources) given the ra-name, returns all the configured connector-work-security-maps for the .rar
static boolean	isApplicationScopedResource(org.glassfish.resourcebase.resources.api.GenericResourceInfo resourceInfo)
static boolean	isDynamicReconfigurationEnabled(com.sun.enterprise.config.serverbeans.ResourcePool pool)
static boolean	isEmbedded(org.glassfish.api.deployment.DeploymentContext context)
static org.glassfish.resourcebase.resources.api.ResourceConstants.TriState	isEmbeddedRarResource(com.sun.enterprise.config.serverbeans.Resource configBeanResource, Collection<com.sun.enterprise.config.serverbeans.Resource> configBeanResources)
static boolean	isJMSRA(String moduleName)
static boolean	isModuleScopedResource(org.glassfish.resourcebase.resources.api.GenericResourceInfo resourceInfo)
static boolean	isRARResource(com.sun.enterprise.config.serverbeans.Resource resource)
static boolean	isStandAloneRA(String moduleName)
static boolean	isValidJndiSuffix(String suffix) If the suffix is one of the valid context return true.
static boolean	parseBoolean(String enabled)
static boolean	systemRarExists(String location)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectorsUtil

public ConnectorsUtil()

Method Detail

belongsToSystemRA

public static boolean belongsToSystemRA(String raName)

determine whether the RAR in question is a System RAR

Parameters:

raName - RarName

Returns:

boolean

getPingDuringPoolCreation

public static boolean getPingDuringPoolCreation(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo,
                                com.sun.enterprise.config.serverbeans.Resources allResources)

belongsToJdbcRA

public static boolean belongsToJdbcRA(String raName)

determine whether the RAR in question is a System RAR

Parameters:

raName - RarName

Returns:

boolean

getSystemModuleLocation

public static String getSystemModuleLocation(String moduleName)

get the installation directory of System RARs

Parameters:

moduleName - RARName

Returns:

directory location

getLocation

public static String getLocation(String moduleName)
                          throws ConnectorRuntimeException

Throws:

ConnectorRuntimeException

getPMJndiName

public static String getPMJndiName(String jndiName)

Return the system PM name for the JNDI name

Parameters:

jndiName - jndi name

Returns:

String jndi name for PM resource

getValidSuffix

public static String getValidSuffix(String name)

check whether the jndi Name has connector related suffix and return if any.

Parameters:

name - jndi name

Returns:

suffix, if found

isValidJndiSuffix

public static boolean isValidJndiSuffix(String suffix)

If the suffix is one of the valid context return true. Return false, if that is not the case.

Parameters:

suffix - __nontx / __pm

Returns:

boolean whether the suffix is valid or not

deriveJndiName

public static String deriveJndiName(String name,
                    Hashtable env)

Given the name of the resource and its jndi env, derive the complete jndi name. (eg; with __PM / __nontx)

Parameters:

name - name of the resource

env - env

Returns:

derived name

getConnectionPoolConfig

public static com.sun.enterprise.config.serverbeans.ResourcePool getConnectionPoolConfig(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo,
                                                                         com.sun.enterprise.config.serverbeans.Resources allResources)

getAllResources

public static Collection<com.sun.enterprise.config.serverbeans.Resource> getAllResources(Collection<String> poolNames,
                                                                         com.sun.enterprise.config.serverbeans.Resources allResources)

getAllPoolNames

public static Collection<String> getAllPoolNames(Collection<ConnectorConnectionPool> connectionPools)

get the list of pool names

Parameters:

connectionPools - list of pools

Returns:

list of pol names

getAllWorkSecurityMaps

public static Collection<WorkSecurityMap> getAllWorkSecurityMaps(com.sun.enterprise.config.serverbeans.Resources resources,
                                                 String moduleName)

getAllPoolsOfModule

public static Collection<ConnectorConnectionPool> getAllPoolsOfModule(String moduleName,
                                                      com.sun.enterprise.config.serverbeans.Resources allResources)

get the pools for a particular resource-adapter

Parameters:

moduleName - resource-adapter name

Returns:

collection of connectorConnectionPool

getAllSystemRAResourcesAndPools

public static Collection<com.sun.enterprise.config.serverbeans.Resource> getAllSystemRAResourcesAndPools(com.sun.enterprise.config.serverbeans.Resources allResources)

Get all System RAR pools and resources

Parameters:

allResources - all configured resources

Returns:

Collection of system RAR pools

getResourceAdapterNameOfPool

public static String getResourceAdapterNameOfPool(String poolName,
                                  com.sun.enterprise.config.serverbeans.Resources allResources)

Given the poolname, retrieve the resourceadapter name

Parameters:

poolName - connection pool name

allResources - resources

Returns:

resource-adapter name

getRAConfig

public static ResourceAdapterConfig getRAConfig(String raName,
                                com.sun.enterprise.config.serverbeans.Resources allResources)

getWorkSecurityMaps

public static List<WorkSecurityMap> getWorkSecurityMaps(String raName,
                                        com.sun.enterprise.config.serverbeans.Resources allResources)

given the ra-name, returns all the configured connector-work-security-maps for the .rar

Parameters:

raName - resource-adapter name

allResources - resources

Returns:

list of work-security-maps

isDynamicReconfigurationEnabled

public static boolean isDynamicReconfigurationEnabled(com.sun.enterprise.config.serverbeans.ResourcePool pool)

getMergedActivationConfigProperties

public static Set getMergedActivationConfigProperties(com.sun.enterprise.deployment.EjbMessageBeanDescriptor msgDesc)

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.

isJMSRA

public static boolean isJMSRA(String moduleName)

parseBoolean

public static boolean parseBoolean(String enabled)

getShutdownTimeout

public static long getShutdownTimeout(ConnectorService connectorService)

Gets the shutdown-timeout attribute from domain.xml via the connector server config bean.

Parameters:

connectorService - connector-service configuration

Returns:

long shutdown timeout (in mill-seconds)

getBuiltInCustomResources

public static Map<String,String> getBuiltInCustomResources()

Provides the list of built in custom resources by resource-type and factory-class-name pair.

Returns:

map of resource-type & factory-class-name

getTransactionIsolationInt

public static String getTransactionIsolationInt(int tranIsolation)

deriveResourceName

public static String deriveResourceName(String compId,
                        String name,
                        org.glassfish.deployment.common.JavaEEResourceType resType)

getReservePrefixedJNDINameForResource

public static String getReservePrefixedJNDINameForResource(String compId,
                                           String resourceName,
                                           org.glassfish.deployment.common.JavaEEResourceType resType)

convertPropertiesToMap

public static Map<String,String> convertPropertiesToMap(Properties properties)

getEmbeddedRarModuleName

public static String getEmbeddedRarModuleName(String applicationName,
                              String moduleName)

getApplicationNameOfEmbeddedRar

public static String getApplicationNameOfEmbeddedRar(String embeddedRarName)

getRarNameFromApplication

public static String getRarNameFromApplication(String appName)

isEmbedded

public static boolean isEmbedded(org.glassfish.api.deployment.DeploymentContext context)

getApplicationName

public static String getApplicationName(org.glassfish.api.deployment.DeploymentContext context)

getInstalledLibrariesFromManifest

public static List<URI> getInstalledLibrariesFromManifest(String moduleDirectory,
                                          org.glassfish.api.admin.ServerEnvironment env)
                                                   throws ConnectorRuntimeException

Throws:

ConnectorRuntimeException

getReservePrefixedJNDINameForDescriptor

public static String getReservePrefixedJNDINameForDescriptor(String moduleName)

isStandAloneRA

public static boolean isStandAloneRA(String moduleName)

getSystemRARs

public static Collection<String> getSystemRARs()

getNonJdbcSystemRars

public static Collection<String> getNonJdbcSystemRars()

systemRarExists

public static boolean systemRarExists(String location)

extractRar

public static boolean extractRar(String fileName,
                 String rarName,
                 String destDir)

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

Parameters:

fileName - rar-directory-name

rarName - resource-adapter name

destDir - destination directory

Returns:

status indicating whether .rar is exploded successfully or not

getPoolInfo

public static org.glassfish.resourcebase.resources.api.PoolInfo getPoolInfo(com.sun.enterprise.config.serverbeans.ResourcePool resource)

getResourceInfo

public static org.glassfish.resourcebase.resources.api.ResourceInfo getResourceInfo(com.sun.enterprise.config.serverbeans.BindableResource resource)

getApplicationName

public static String getApplicationName(com.sun.enterprise.config.serverbeans.Resource resource)

getApplicationName

public static String getApplicationName(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo)

isApplicationScopedResource

public static boolean isApplicationScopedResource(org.glassfish.resourcebase.resources.api.GenericResourceInfo resourceInfo)

isModuleScopedResource

public static boolean isModuleScopedResource(org.glassfish.resourcebase.resources.api.GenericResourceInfo resourceInfo)

escapeResourceNameForMonitoring

public static String escapeResourceNameForMonitoring(String name)

getPoolMonitoringSubTreeRoot

public static String getPoolMonitoringSubTreeRoot(org.glassfish.resourcebase.resources.api.PoolInfo poolInfo,
                                  boolean escapeSlashes)

getActualModuleName

public static String getActualModuleName(String moduleName)

getModuleName

public static String getModuleName(com.sun.enterprise.deployment.EjbDescriptor descriptor)

getResourcesOfPool

public static Collection<com.sun.enterprise.config.serverbeans.BindableResource> getResourcesOfPool(com.sun.enterprise.config.serverbeans.Resources resources,
                                                                                    String connectionPoolName)

getResourceByName

public static <T> com.sun.enterprise.config.serverbeans.Resource getResourceByName(com.sun.enterprise.config.serverbeans.Resources resources,
                                                                   Class<T> type,
                                                                   String name)

isEmbeddedRarResource

public static org.glassfish.resourcebase.resources.api.ResourceConstants.TriState isEmbeddedRarResource(com.sun.enterprise.config.serverbeans.Resource configBeanResource,
                                                                                        Collection<com.sun.enterprise.config.serverbeans.Resource> configBeanResources)

getPool

public static ConnectorConnectionPool getPool(Collection<com.sun.enterprise.config.serverbeans.Resource> configBeanResources,
                              String poolName)

isRARResource

public static boolean isRARResource(com.sun.enterprise.config.serverbeans.Resource resource)

getRarNameOfResource

public static String getRarNameOfResource(com.sun.enterprise.config.serverbeans.Resource resource,
                          com.sun.enterprise.config.serverbeans.Resources resources)