fish.payara.microprofile.faulttolerance.cdi.FaultToleranceExtension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) [2017-2022] 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.faulttolerance.cdi;
import fish.payara.microprofile.faulttolerance.FaultToleranceConfig;
import fish.payara.microprofile.faulttolerance.policy.FaultTolerancePolicy;
import fish.payara.microprofile.faulttolerance.service.FaultToleranceUtils;
import org.eclipse.microprofile.config.ConfigProvider;
import org.eclipse.microprofile.faulttolerance.Asynchronous;
import org.eclipse.microprofile.faulttolerance.Bulkhead;
import org.eclipse.microprofile.faulttolerance.CircuitBreaker;
import org.eclipse.microprofile.faulttolerance.Fallback;
import org.eclipse.microprofile.faulttolerance.FallbackHandler;
import org.eclipse.microprofile.faulttolerance.Retry;
import org.eclipse.microprofile.faulttolerance.Timeout;
import jakarta.annotation.Priority;
import jakarta.enterprise.context.spi.CreationalContext;
import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.spi.AfterBeanDiscovery;
import jakarta.enterprise.inject.spi.AfterTypeDiscovery;
import jakarta.enterprise.inject.spi.Annotated;
import jakarta.enterprise.inject.spi.AnnotatedMethod;
import jakarta.enterprise.inject.spi.AnnotatedType;
import jakarta.enterprise.inject.spi.BeanAttributes;
import jakarta.enterprise.inject.spi.BeanManager;
import jakarta.enterprise.inject.spi.BeforeBeanDiscovery;
import jakarta.enterprise.inject.spi.Extension;
import jakarta.enterprise.inject.spi.InjectionPoint;
import jakarta.enterprise.inject.spi.InjectionTarget;
import jakarta.enterprise.inject.spi.InterceptionType;
import jakarta.enterprise.inject.spi.Interceptor;
import jakarta.enterprise.inject.spi.ProcessAnnotatedType;
import jakarta.enterprise.inject.spi.WithAnnotations;
import jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator;
import jakarta.enterprise.inject.spi.InjectionTargetFactory;
import jakarta.interceptor.InvocationContext;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.time.temporal.ChronoUnit;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
/**
* CDI Extension that does the setup for FT interceptor handling.
*
* @author Andrew Pielage
* @author Jan Bernitt (2.0)
*/
public class FaultToleranceExtension implements Extension {
private static final String INTERCEPTOR_PRIORITY_PROPERTY = "mp.fault.tolerance.interceptor.priority";
void beforeBeanDiscovery(@Observes BeforeBeanDiscovery beforeBeanDiscovery, BeanManager beanManager) {
beforeBeanDiscovery.addAnnotatedType(beanManager.createAnnotatedType(FaultToleranceInterceptor.class), "MP-FT");
}
/**
*
* @param processAnnotatedType type currently processed
*/
void processAnnotatedType(@Observes @WithAnnotations({ Asynchronous.class, Bulkhead.class, CircuitBreaker.class,
Fallback.class, Retry.class, Timeout.class }) ProcessAnnotatedType processAnnotatedType) throws Exception {
// TODO: To support alternative asynchronous annotations we need to add FT Asynchronous annotation.
Class[] alternativeAsynchronousAnnotations = getAlternativeAsynchronousAnnotations();
AnnotatedType type = processAnnotatedType.getAnnotatedType();
boolean markAllMethods = FaultToleranceUtils.isAnnotatedWithFaultToleranceAnnotations(type)
|| isAnyAnnotationPresent(type, alternativeAsynchronousAnnotations);
Class targetClass = type.getJavaClass();
for (AnnotatedMethodConfigurator methodConfigurator : processAnnotatedType.configureAnnotatedType().methods()) {
AnnotatedMethod method = methodConfigurator.getAnnotated();
if (markAllMethods || FaultToleranceUtils.isAnnotatedWithFaultToleranceAnnotations(method)
|| isAnyAnnotationPresent(method, alternativeAsynchronousAnnotations)) {
FaultTolerancePolicy.asAnnotated(targetClass, method.getJavaMember());
}
}
}
private static boolean isAnyAnnotationPresent(Annotated element, Class[] annotationTypes) {
for (Class annotationType : annotationTypes) {
if (element.isAnnotationPresent(annotationType)) {
return true;
}
}
return false;
}
private static Class[] getAlternativeAsynchronousAnnotations() {
Optional alternativeAsynchronousAnnotationNames = ConfigProvider.getConfig().getOptionalValue(
FaultToleranceConfig.ALTERNATIVE_ASYNCHRONOUS_ANNNOTATIONS_PROPERTY, String.class);
return alternativeAsynchronousAnnotationNames.isPresent()
? FaultToleranceUtils.toClassArray(alternativeAsynchronousAnnotationNames.get(),
FaultToleranceConfig.ALTERNATIVE_ASYNCHRONOUS_ANNNOTATIONS_PROPERTY,
FaultToleranceConfig.NO_ALTERNATIVE_ANNOTATIONS)
: FaultToleranceConfig.NO_ALTERNATIVE_ANNOTATIONS;
}
void enableInterceptor(@Observes AfterTypeDiscovery afterTypeDiscovery) {
// Determine the priority of our interceptor
int priority = ConfigProvider.getConfig().getOptionalValue(INTERCEPTOR_PRIORITY_PROPERTY,
Integer.class).orElse(jakarta.interceptor.Interceptor.Priority.PLATFORM_AFTER + 15);
// Enable our interceptor since we're adding it programmatically rather than via annotation, adding it
// at the appropriate index (since the list has already been sorted)
List> interceptors = afterTypeDiscovery.getInterceptors();
int index = determineInterceptorIndex(interceptors, priority);
if (index != interceptors.size() - 1 || index > interceptors.size() - 1) {
afterTypeDiscovery.getInterceptors().add(index, FaultToleranceInterceptor.class);
} else {
afterTypeDiscovery.getInterceptors().add(FaultToleranceInterceptor.class);
}
}
static int determineInterceptorIndex(List> interceptorsList, int priority) {
int index = interceptorsList.size() - 1;
// Binary search - sometimes another interceptor gets added after the list is sorted (WeldCdi1x), so running
// backwards through the list under the assumption that most Payara interceptors are registered at
// PLATFORM_AFTER is not always guaranteed to register this interceptor at the right point.
int lowIndex = 0;
int highIndex = interceptorsList.size() - 1;
while (lowIndex <= highIndex) {
int midIndex = lowIndex + ((highIndex - lowIndex) / 2);
Priority priorityAnnotation = interceptorsList.get(midIndex).getAnnotation(Priority.class);
// If no priority annotation, assume APPLICATION
int priorityAnnotationValue = priorityAnnotation != null ? priorityAnnotation.value() :
jakarta.interceptor.Interceptor.Priority.APPLICATION;
// Check for a matching priority value, otherwise determine which way to move the search
if (priorityAnnotationValue < priority) {
lowIndex = midIndex + 1;
} else if (priorityAnnotationValue > priority) {
highIndex = midIndex - 1;
} else if (priorityAnnotationValue == priority) {
index = midIndex;
break;
}
}
// If the index isn't at its default of the last element in the array, that implies we found a matching priority
// so just add it at that point
if (index != interceptorsList.size() - 1) {
return index;
} else {
// If the highIndex isn't the last element in the list, that implies we narrowed down on an index but
// found no matching priority
if (highIndex != interceptorsList.size() - 1) {
// If the lowIndex is greater than highIndex that means the narrowed down mid point has a lower priority
// If the lowIndex is less than highIndex that means the narrowed down mid point has a greater priority
// In either case, we want to use the low index so that we're either before or after it
return lowIndex;
} else {
return interceptorsList.size() - 1;
}
}
}
void installInterceptor(@Observes AfterBeanDiscovery afterBeanDiscovery, BeanManager beanManager) {
// Registers all Fault Tolerance annotations against our programmatic interceptor
AnnotatedType at = afterBeanDiscovery.getAnnotatedType(
FaultToleranceInterceptor.class, "MP-FT");
ALL_BINDINGS.forEach(a -> afterBeanDiscovery.addBean(new ProgrammaticInterceptor(at, beanManager, a)));
}
/**
* Programmatic Interceptor for all Fault Tolerance annotations, since Weld won't pick up our
* "not quite stereotype" synthetic interceptor on the Rest Client side (WARNING: NO TCK TEST FOR THIS).
*/
static class ProgrammaticInterceptor implements Interceptor {
private final BeanManager bm;
private final Annotation binding;
private final BeanAttributes beanAttributes;
private final InjectionTarget injectionTarget;
ProgrammaticInterceptor(AnnotatedType at, BeanManager bm, Annotation binding) {
this.bm = bm;
this.binding = binding;
beanAttributes = bm.createBeanAttributes(at);
InjectionTargetFactory itf = bm.getInjectionTargetFactory(at);
injectionTarget = itf.createInjectionTarget(null);
}
@Override
public Set getInterceptorBindings() {
return Collections.singleton(binding);
}
@Override
public boolean intercepts(InterceptionType type) {
return type == InterceptionType.AROUND_INVOKE;
}
@Override
public Object intercept(InterceptionType type, FaultToleranceInterceptor instance, InvocationContext ctx) throws Exception {
return instance.intercept(ctx);
}
@Override
public Class getBeanClass() {
return FaultToleranceInterceptor.class;
}
@Override
public Set getInjectionPoints() {
return injectionTarget.getInjectionPoints();
}
@Override
public FaultToleranceInterceptor create(CreationalContext creationalContext) {
FaultToleranceInterceptor instance = injectionTarget.produce(creationalContext);
injectionTarget.inject(instance, creationalContext);
injectionTarget.postConstruct(instance);
return instance;
}
@Override
public void destroy(FaultToleranceInterceptor instance, CreationalContext creationalContext) {
try {
injectionTarget.preDestroy(instance);
injectionTarget.dispose(instance);
} finally {
creationalContext.release();
}
}
@Override
public Set getTypes() {
return beanAttributes.getTypes();
}
@Override
public Set getQualifiers() {
return beanAttributes.getQualifiers();
}
@Override
public Class getScope() {
return beanAttributes.getScope();
}
@Override
public String getName() {
return beanAttributes.getName();
}
@Override
public Set> getStereotypes() {
return beanAttributes.getStereotypes();
}
@Override
public boolean isAlternative() {
return beanAttributes.isAlternative();
}
}
/**
* "Not quite" literal annotation impls for each of the Fault Tolerance annotations. The default values of the
* overridden methods don't need to match those of the "official" annotation since these are just placeholders.
*/
private static final Collection ALL_BINDINGS = Arrays.asList(
new Asynchronous() {
@Override
public Class annotationType() {
return Asynchronous.class;
}
},
new Bulkhead(){
@Override
public Class annotationType() {
return Bulkhead.class;
}
@Override
public int value() {
return 0;
}
@Override
public int waitingTaskQueue() {
return 0;
}
},
new CircuitBreaker() {
@Override
public Class annotationType() {
return CircuitBreaker.class;
}
@Override
public Class[] failOn() {
return new Class[0];
}
@Override
public Class[] skipOn() {
return new Class[0];
}
@Override
public long delay() {
return 0;
}
@Override
public ChronoUnit delayUnit() {
return null;
}
@Override
public int requestVolumeThreshold() {
return 0;
}
@Override
public double failureRatio() {
return 0;
}
@Override
public int successThreshold() {
return 0;
}
},
new Fallback() {
@Override
public Class annotationType() {
return Fallback.class;
}
@Override
public Class> value() {
return null;
}
@Override
public String fallbackMethod() {
return null;
}
@Override
public Class[] applyOn() {
return new Class[0];
}
@Override
public Class[] skipOn() {
return new Class[0];
}
},
new Retry() {
@Override
public Class annotationType() {
return Retry.class;
}
@Override
public int maxRetries() {
return 0;
}
@Override
public long delay() {
return 0;
}
@Override
public ChronoUnit delayUnit() {
return null;
}
@Override
public long maxDuration() {
return 0;
}
@Override
public ChronoUnit durationUnit() {
return null;
}
@Override
public long jitter() {
return 0;
}
@Override
public ChronoUnit jitterDelayUnit() {
return null;
}
@Override
public Class[] retryOn() {
return new Class[0];
}
@Override
public Class[] abortOn() {
return new Class[0];
}
},
new Timeout() {
@Override
public Class annotationType() {
return Timeout.class;
}
@Override
public long value() {
return 0;
}
@Override
public ChronoUnit unit() {
return null;
}
}
);
}