Skip to content

Commit

Permalink
Merge pull request #5112 from MattGill98/FISH-658
Browse files Browse the repository at this point in the history
FISH-658 MP Config @ConfigProperties Support
  • Loading branch information
MattGill98 authored Feb 3, 2021
2 parents 61a3b4e + c6acac2 commit ca0a8f7
Show file tree
Hide file tree
Showing 5 changed files with 246 additions and 195 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2017 Payara Foundation and/or its affiliates. All rights reserved.
* Copyright (c) [2017-2021] Payara Foundation 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
Expand Down Expand Up @@ -68,6 +68,8 @@
*/
public class ConfigCdiExtension implements Extension {

private Set<Type> configPropertiesBeanTypes = new HashSet<>();

public void validateInjectionPoint(@Observes ProcessInjectionPoint<?, ?> pip) {

// we need to validate the injection point for the ConfigProperty to meet the 3
Expand Down Expand Up @@ -106,53 +108,6 @@ public void validateInjectionPoint(@Observes ProcessInjectionPoint<?, ?> pip) {
}
}

// FIXME: this method is currently here to intercept injection of @ConfigProperties
// injected targets. I'm thinking that this might be a good target for injecting the fields.
public <T> void processConfigPropertiesInjection(
@Observes ProcessInjectionTarget<T> event) {
final InjectionTarget<T> it = event.getInjectionTarget();

final Map<Field, Object> configuredValues = new HashMap<Field, Object>();

final AnnotatedType<T> at = event.getAnnotatedType();

if (at.isAnnotationPresent(ConfigProperties.class)) {
event.setInjectionTarget(new InjectionTarget<T>() {

@Override
public T produce(CreationalContext<T> ctx) {
return it.produce(ctx);
}

@Override
public void dispose(T instance) {
it.dispose(instance);
}

@Override
public Set<InjectionPoint> getInjectionPoints() {
return it.getInjectionPoints();
}

@Override
public void inject(T instance, CreationalContext<T> ctx) {
it.inject(instance, ctx);
}

@Override
public void postConstruct(T instance) {
it.postConstruct(instance);
}

@Override
public void preDestroy(T instance) {
it.preDestroy(instance);
}

});
}
}

/**
* Register the ConfigProducer bean that has producer methods for Config and Optional
* @param event
Expand All @@ -163,15 +118,20 @@ public void createConfigProducer(@Observes BeforeBeanDiscovery event, BeanManage
event.addAnnotatedType(at, ConfigProducer.class.getName());
}

// FIXME: this is only here as a proof of concept. It needs refactoring
private Set<Type> types = new HashSet<>();

// FIXME: needs refactoring.
// Currently, this fetches the type of every injected @ConfigProperties object
public <T> void storeConfigPropertiesType(@Observes @WithAnnotations(ConfigProperties.class) ProcessAnnotatedType<T> event) {
event.getAnnotatedType().getFields().stream()
.filter(field -> field.isAnnotationPresent(ConfigProperties.class))
.forEach(field -> types.add(field.getBaseType()));

final AnnotatedType<?> type = event.getAnnotatedType();

if (type.getJavaClass().isAnnotationPresent(ConfigProperties.class)) {
event.veto();
return;
}
for (AnnotatedField<?> field : type.getFields()) {
final Class<?> memberClass = field.getJavaMember().getType();
if (memberClass.isAnnotationPresent(ConfigProperties.class)) {
configPropertiesBeanTypes.add(memberClass);
}
}
}

/**
Expand All @@ -188,51 +148,50 @@ public void addDynamicProducers(@Observes AfterBeanDiscovery event, BeanManager
Config config = ConfigProvider.getConfig();
if (config instanceof PayaraConfig) {

AnnotatedType<ConfigPropertyProducer> producerType = bm.createAnnotatedType(ConfigPropertyProducer.class);
BeanAttributes<?> producerBeanAttributes = null;
AnnotatedMethod<? super ConfigPropertyProducer> producerMethod = null;
for (AnnotatedMethod m : producerType.getMethods()) {
if (m.getJavaMember().getName().equals("getGenericObject")) {
// create a bean attributes based on this method
producerBeanAttributes = bm.createBeanAttributes(m);
producerMethod = m;
break;
}
}

// FIXME: may need refactoring.
// This currently registers the producer method as being valid
// for each discovered injected @ConfigProperties type
if (producerBeanAttributes != null && !types.isEmpty()) {
Bean<?> bean = bm.createBean(new TypesBeanAttributes<Object>(producerBeanAttributes){
@Override
public Set<Type> getTypes() {
return types;
}
}, ConfigPropertyProducer.class,
bm.getProducerFactory(producerMethod, null));
event.addBean(bean);
}
final AnnotatedType<ConfigPropertyProducer> propertyProducerType = bm.createAnnotatedType(ConfigPropertyProducer.class);
final AnnotatedType<ConfigPropertiesProducer> objectProducerType = bm.createAnnotatedType(ConfigPropertiesProducer.class);

// create a synthetic bean based on the ConfigPropertyProducer which
// has a method we can use to create the correct objects based on
// the InjectionPoint
AnnotatedType<ConfigPropertyProducer> atype = bm.createAnnotatedType(ConfigPropertyProducer.class);
BeanAttributes<?> beanAttr = null;
BeanAttributes<?> propertyBeanAttributes = null;
BeanAttributes<?> objectBeanAttributes = null;

// first find the producer method
AnnotatedMethod<? super ConfigPropertyProducer> method = null;
for (AnnotatedMethod m : atype.getMethods()) {
if (m.getJavaMember().getName().equals("getGenericProperty")) {
AnnotatedMethod<? super ConfigPropertyProducer> propertyProducerMethod = null;
AnnotatedMethod<? super ConfigPropertiesProducer> objectProducerMethod = null;

for (AnnotatedMethod m : propertyProducerType.getMethods()) {
final String methodName = m.getJavaMember().getName();
if (methodName.equals("getGenericProperty")) {
// create a bean attributes based on this method
beanAttr = bm.createBeanAttributes(m);
method = m;
propertyBeanAttributes = bm.createBeanAttributes(m);
propertyProducerMethod = m;
break;
}
}
for (AnnotatedMethod m : objectProducerType.getMethods()) {
final String methodName = m.getJavaMember().getName();
if (methodName.equals("getGenericObject")) {
objectBeanAttributes = bm.createBeanAttributes(m);
objectProducerMethod = m;
break;
}
}

if (objectProducerMethod != null & !configPropertiesBeanTypes.isEmpty()) {
Bean<?> bean = bm.createBean(new TypesBeanAttributes<Object>(objectBeanAttributes){
@Override
public Set<Type> getTypes() {
return configPropertiesBeanTypes;
}
}, ConfigPropertiesProducer.class,
bm.getProducerFactory(objectProducerMethod, null));
event.addBean(bean);
}

// we have the method
if (beanAttr != null) {
// if we have the producer method
if (propertyProducerMethod != null) {
HashSet<Type> types = new HashSet<>();
types.add(ConfigValue.class);
types.addAll(((PayaraConfig) config).getConverterTypes());
Expand All @@ -243,7 +202,7 @@ public Set<Type> getTypes() {
// create a bean with a Producer method using the bean factory and with custom bean attributes
// also override the set of types depending on the type of the converter
for (final Type converterType : types) {
Bean<?> bean = bm.createBean(new TypesBeanAttributes<Object>(beanAttr) {
Bean<?> bean = bm.createBean(new TypesBeanAttributes<Object>(propertyBeanAttributes) {

// overrides the bean types to return the types registered for a Converter
@Override
Expand Down Expand Up @@ -280,7 +239,7 @@ public Set<Type> getTypes() {

return result;
}
}, ConfigPropertyProducer.class, bm.getProducerFactory(method, null));
}, ConfigPropertyProducer.class, bm.getProducerFactory(propertyProducerMethod, null));
event.addBean(bean);
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) [2021] Payara Foundation 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://github.com/payara/Payara/blob/master/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 glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation 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.
*/
package fish.payara.microprofile.config.cdi;

import static org.eclipse.microprofile.config.inject.ConfigProperties.UNCONFIGURED_PREFIX;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Type;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.enterprise.inject.spi.Annotated;
import javax.enterprise.inject.spi.AnnotatedField;
import javax.enterprise.inject.spi.AnnotatedType;
import javax.enterprise.inject.spi.BeanManager;
import javax.enterprise.inject.spi.InjectionPoint;

import org.eclipse.microprofile.config.inject.ConfigProperties;

import fish.payara.microprofile.config.cdi.model.ConfigPropertyModel;

public class ConfigPropertiesProducer {

private static final Logger LOGGER = Logger.getLogger(ConfigPropertiesProducer.class.getName());

@ConfigProperties
public static final Object getGenericObject(InjectionPoint injectionPoint, BeanManager bm)
throws InstantiationException, IllegalAccessException {
Type type = injectionPoint.getType();
if (!(type instanceof Class)) {
throw new IllegalArgumentException("Unable to process injection point with @ConfigProperties of type " + type);
}

// Initialise the object. This may throw exceptions
final Object object = ((Class) type).newInstance();

// Model the class
final AnnotatedType<?> annotatedType = bm.createAnnotatedType((Class) type);

// Find the @ConfigProperties annotations, and calculate the property prefix
final ConfigProperties injectionAnnotation = getQualifier(injectionPoint);
final ConfigProperties classAnnotation = annotatedType.getAnnotation(ConfigProperties.class);
final String prefix = parsePrefixes(injectionAnnotation, classAnnotation);

for (AnnotatedField<?> field : annotatedType.getFields()) {

// Find the java field and field name
final Field javaField = field.getJavaMember();

// Make sure the field is accessible
javaField.setAccessible(true);

// Model the field
final InjectionPoint fieldInjectionPoint = bm.createInjectionPoint(field);
final ConfigPropertyModel model = new ConfigPropertyModel(fieldInjectionPoint, prefix);

try {
final Object value = ConfigPropertyProducer.getGenericPropertyFromModel(model);

if (value != null) {
javaField.set(object, value);
}
} catch (Exception ex) {
if (javaField.get(object) == null) {
LOGGER.log(Level.WARNING, String.format("Unable to inject property with name %s into type %s.",
model.getName(), type.getTypeName()), ex);
throw ex;
}
}
}

return object;
}

private static ConfigProperties getQualifier(InjectionPoint injectionPoint) {

// If it's an @Inject point
final Annotated annotated = injectionPoint.getAnnotated();
if (annotated != null) {
return annotated.getAnnotation(ConfigProperties.class);
}

// If it's a programmatic lookup
final Set<Annotation> qualifiers = injectionPoint.getQualifiers();
for (Annotation qualifier : qualifiers) {
if (qualifier instanceof ConfigProperties) {
return (ConfigProperties) qualifier;
}
}

return null;
}

private static String parsePrefixes(ConfigProperties injectionAnnotation, ConfigProperties classAnnotation) {
final String injectionPrefix = parsePrefix(injectionAnnotation);
if (injectionPrefix != null) {
return injectionPrefix;
}
return parsePrefix(classAnnotation);
}

private static String parsePrefix(ConfigProperties annotation) {
if (annotation == null) {
return null;
}
final String value = annotation.prefix();
if (value == null || value.equals(UNCONFIGURED_PREFIX)) {
return null;
}
if (value.isEmpty()) {
return "";
}
return value + ".";
}

}

This file was deleted.

Loading

0 comments on commit ca0a8f7

Please sign in to comment.