Package com.sun.enterprise.config.modularity

Class ConfigModularityUtils

java.lang.Object

com.sun.enterprise.config.modularity.ConfigModularityUtils

@Service
public final class ConfigModularityUtils
extends Object

Contains utility methods for zero-config

Author:

Masoud Kalali

Constructor Summary

Constructors

Constructor	Description
ConfigModularityUtils()

Method Summary

Modifier and Type	Method	Description
void	addSystemPropertyForToken(List<ConfigCustomizationToken> tokens, SystemPropertyBag bag)
<T extends ConfigBeanProxy> void	applyCustomTokens(ConfigBeanDefaultValue configBeanDefaultValue, T finalConfigBean, ConfigBeanProxy parent)
boolean	checkInterfaces(Class[] ifs, Type actualGenericParameter)
String	convertConfigElementNameToClassName(String name)	convert a configuration element name to representing class name
boolean	deleteConfigurationForConfigBean(ConfigBeanProxy configBean, Collection col, ConfigBeanDefaultValue defaultValue)
Method	findDeeperSuitableCollectionGetter(Class owner, Class typeToSet)
Method	findSuitableCollectionGetter(Class owner, Class typeToSet)	Find a getter method that returns a collection of the type we want to put set.
List<Class>	getAnnotatedConfigBeans(Class annotationType)
Class	getClassFor(String serviceName)
Class	getClassForFullName(String configBeanClassName)
Class	getClassFromDescriptor(org.glassfish.hk2.api.ActiveDescriptor<?> descriptor)
Class	getClassFromInjector(ConfigInjector injector)
<T extends ConfigBeanProxy> T	getConfigBeanFromCollection(Collection<T> col, T configBeanObject, Class typeOfObjects)
ConfigBeanProxy	getConfigBeanInstanceFor(Class configBeanType)
<U extends ConfigBeanProxy> URL	getConfigurationFileUrl(Class<U> configBeanClass, String baseFileName, String runtimeType)
<T extends ConfigBeanProxy> T	getCurrentConfigBeanForDefaultValue(ConfigBeanDefaultValue defaultValue)
List<ConfigBeanDefaultValue>	getDefaultConfigurations(Class configBeanClass, String runtimeType)	If exists, locate and return a URL to the configuration snippet for the given config bean class.
Class	getDuckClass(Class configBeanType)
<U extends ConfigBeanProxy> List<U>	getExtensions(ConfigBeanProxy parent)
Method	getGetDefaultValuesMethod(Class configBeanType)
List<Class>	getInstalledExtensions(Class extensionType)
Method	getMatchingGetterMethod(Class classToQuery, Class methodReturnType)	Find a suitable getter method in the given class.
Method	getMatchingSetterMethod(Class classToQuery, Class typeToSet)	Finds and return the setter method matching the class identified by typeToSet
<T extends ConfigBeanProxy> T	getNamedConfigBeanFromCollection(Collection<T> col, String nameToLookFor, Class typeOfObjects)
String	getNameForConfigBean(Object configBean, Class configBeanType)
ConfigBeanProxy	getOwner(ConfigBeanProxy parent, String parentElement, String childElement)
Class	getOwningClassForLocation(String location)
ConfigBeanProxy	getOwningObject(String location)
String	getPropertyValue(ConfigCustomizationToken token, ConfigBeanProxy finalConfigBean)
String	getRuntimeTypePrefix(com.sun.enterprise.module.bootstrap.StartupContext startupContext)
String	getServiceTypeNameIfNamedComponent(String serviceName)
boolean	hasCustomConfig(Class configBeanClass)
boolean	isCommandInvocation()
boolean	isIgnorePersisting()
String	replacePropertiesWithCurrentValue(String xmlConfiguration, ConfigBeanDefaultValue value)
String	resolveExpression(String expression)
String	serializeConfigBean(ConfigBeanProxy configBean)
String	serializeConfigBeanByType(Class configBeanType)
void	setCommandInvocation(boolean commandInvocation)
<T extends ConfigBeanProxy> T	setConfigBean(T finalConfigBean, ConfigBeanDefaultValue configBeanDefaultValue, ConfigBeanProxy parent)
void	setIgnorePersisting(boolean ignorePersisting)
<T extends ConfigBeanProxy> boolean	stackPositionHigher(T finalConfigBean, ConfigBeanProxy itemToRemove)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigModularityUtils

public ConfigModularityUtils()

Method Detail

getConfigurationFileUrl

public <U extends ConfigBeanProxy> URL getConfigurationFileUrl(Class<U> configBeanClass,
                                                               String baseFileName,
                                                               String runtimeType)

getDefaultConfigurations

public List<ConfigBeanDefaultValue> getDefaultConfigurations(Class configBeanClass,
                                                             String runtimeType)

If exists, locate and return a URL to the configuration snippet for the given config bean class.

Parameters:

configBeanClass - the config bean type we want to check for its configuration snippet

Returns:

A url to the file or null of not exists

hasCustomConfig

public boolean hasCustomConfig(Class configBeanClass)

findSuitableCollectionGetter

public Method findSuitableCollectionGetter(Class owner,
                                           Class typeToSet)

Find a getter method that returns a collection of the type we want to put set.

Parameters:

owner - The class we want to search to find a method that returns a Collection typed with toSetType

typeToSet - The type we want to find a matching collection fo

Returns:

The Method that

findDeeperSuitableCollectionGetter

public Method findDeeperSuitableCollectionGetter(Class owner,
                                                 Class typeToSet)

checkInterfaces

public boolean checkInterfaces(Class[] ifs,
                               Type actualGenericParameter)

getOwningClassForLocation

public Class getOwningClassForLocation(String location)

getOwningObject

public ConfigBeanProxy getOwningObject(String location)

getOwner

public ConfigBeanProxy getOwner(ConfigBeanProxy parent,
                                String parentElement,
                                String childElement)
                         throws InvocationTargetException,
                                IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

getExtensions

public <U extends ConfigBeanProxy> List<U> getExtensions(ConfigBeanProxy parent)

setConfigBean

public <T extends ConfigBeanProxy> T setConfigBean(T finalConfigBean,
                                                   ConfigBeanDefaultValue configBeanDefaultValue,
                                                   ConfigBeanProxy parent)

stackPositionHigher

public <T extends ConfigBeanProxy> boolean stackPositionHigher(T finalConfigBean,
                                                               ConfigBeanProxy itemToRemove)

applyCustomTokens

public <T extends ConfigBeanProxy> void applyCustomTokens(ConfigBeanDefaultValue configBeanDefaultValue,
                                                          T finalConfigBean,
                                                          ConfigBeanProxy parent)
                                                   throws TransactionFailure,
                                                          PropertyVetoException

Throws:

TransactionFailure

PropertyVetoException

addSystemPropertyForToken

public void addSystemPropertyForToken(List<ConfigCustomizationToken> tokens,
                                      SystemPropertyBag bag)
                               throws TransactionFailure,
                                      PropertyVetoException

Throws:

TransactionFailure

PropertyVetoException

getCurrentConfigBeanForDefaultValue

public <T extends ConfigBeanProxy> T getCurrentConfigBeanForDefaultValue(ConfigBeanDefaultValue defaultValue)
                                                                  throws InvocationTargetException,
                                                                         IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

getConfigBeanFromCollection

public <T extends ConfigBeanProxy> T getConfigBeanFromCollection(Collection<T> col,
                                                                 T configBeanObject,
                                                                 Class typeOfObjects)
                                                          throws InvocationTargetException,
                                                                 IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

getNamedConfigBeanFromCollection

public <T extends ConfigBeanProxy> T getNamedConfigBeanFromCollection(Collection<T> col,
                                                                      String nameToLookFor,
                                                                      Class typeOfObjects)
                                                               throws InvocationTargetException,
                                                                      IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

getNameForConfigBean

public String getNameForConfigBean(Object configBean,
                                   Class configBeanType)
                            throws InvocationTargetException,
                                   IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

convertConfigElementNameToClassName

public String convertConfigElementNameToClassName(String name)

convert a configuration element name to representing class name

Parameters:

name - the configuration element name we want to convert to class name

Returns:

the class name which the configuration element represent.

getClassFor

public Class getClassFor(String serviceName)

getClassFromInjector

public Class getClassFromInjector(ConfigInjector injector)

getServiceTypeNameIfNamedComponent

public String getServiceTypeNameIfNamedComponent(String serviceName)

resolveExpression

public String resolveExpression(String expression)

serializeConfigBeanByType

public String serializeConfigBeanByType(Class configBeanType)

getConfigBeanInstanceFor

public ConfigBeanProxy getConfigBeanInstanceFor(Class configBeanType)

serializeConfigBean

public String serializeConfigBean(ConfigBeanProxy configBean)

getMatchingGetterMethod

public Method getMatchingGetterMethod(Class classToQuery,
                                      Class methodReturnType)

Find a suitable getter method in the given class. the returned method represent a method that will return back a type of methodReturnType.

Parameters:

classToQuery - The class we want to find the getter in

methodReturnType - the type we want to find the getter for

Returns:

A Method object for a getter method in the classToQuery which returns the methodReturnType

getMatchingSetterMethod

public Method getMatchingSetterMethod(Class classToQuery,
                                      Class typeToSet)

Finds and return the setter method matching the class identified by typeToSet

Parameters:

classToQuery - The ConfigLoader we want to inspect for presence of a setter method accepting class of type fqcn.

typeToSet - the type we want to find a setter for

Returns:

the matching Method object or null if not present.

getDuckClass

public Class getDuckClass(Class configBeanType)

getGetDefaultValuesMethod

public Method getGetDefaultValuesMethod(Class configBeanType)

deleteConfigurationForConfigBean

public boolean deleteConfigurationForConfigBean(ConfigBeanProxy configBean,
                                                Collection col,
                                                ConfigBeanDefaultValue defaultValue)

getClassForFullName

public Class getClassForFullName(String configBeanClassName)

getClassFromDescriptor

public Class getClassFromDescriptor(org.glassfish.hk2.api.ActiveDescriptor<?> descriptor)

replacePropertiesWithCurrentValue

public String replacePropertiesWithCurrentValue(String xmlConfiguration,
                                                ConfigBeanDefaultValue value)
                                         throws InvocationTargetException,
                                                IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

getPropertyValue

public String getPropertyValue(ConfigCustomizationToken token,
                               ConfigBeanProxy finalConfigBean)

getRuntimeTypePrefix

public String getRuntimeTypePrefix(com.sun.enterprise.module.bootstrap.StartupContext startupContext)

getAnnotatedConfigBeans

public List<Class> getAnnotatedConfigBeans(Class annotationType)

isIgnorePersisting

public boolean isIgnorePersisting()

setIgnorePersisting

public void setIgnorePersisting(boolean ignorePersisting)

isCommandInvocation

public boolean isCommandInvocation()

setCommandInvocation

public void setCommandInvocation(boolean commandInvocation)

getInstalledExtensions

public List<Class> getInstalledExtensions(Class extensionType)