GERONIMO-6598 - Ability to customize the executor service. Document some of the integration needs.
diff --git a/README.md b/README.md
index 6bbd287..e7ed37f 100644
--- a/README.md
+++ b/README.md
@@ -49,3 +49,31 @@
```
Apache Safeguard implements the [MicroProfile Fault Tolerance v1.0 specification](https://github.com/eclipse/microprofile-fault-tolerance/releases/tag/1.0)
+
+### Integration
+
+The core of Safeguard is wrapped around an `ExecutionManager` which takes care of coordinating and storing the execution state of various methods. It allows some configurability, but if you want to change it your best solution is to create an alternative of `ExecutionManager` with your customizations. For instance, in an EE environment you may want to use a `ManagedScheduledExecutorService` which could be done:
+
+```java
+@ApplicationScoped
+@Specializes
+@Priority(100)
+public class MyExecutionManagerProvider extends FailsafeExecutionManagerProvider{
+ @Resource
+ private ManagedScheduledExecutorService executorService;
+ @Produces
+ @ApplicationScoped
+ public ExecutionManager createExecutionManager() {
+ FailsafeCircuitBreakerManager circuitBreakerManager = new FailsafeCircuitBreakerManager();
+ FailsafeRetryManager retryManager = new FailsafeRetryManager();
+ BulkheadManagerImpl bulkheadManager = new BulkheadManagerImpl();
+ DefaultExecutorServiceProvider executorServiceProvider = new DefaultExecutorServiceProvider(executorService);
+ ExecutionPlanFactory executionPlanFactory = new ExecutionPlanFactory(circuitBreakerManager, retryManager, bulkheadManager, mapper,
+ executorServiceProvider);
+ return FailsafeExecutionManager(MicroprofileAnnotationMapper.getInstance(), bulkheadManager, circuitBreakerManager,
+ retryManager, executionPlanFactory, executorServiceProvider);
+ }
+}
+
+
+```
\ No newline at end of file
diff --git a/safeguard-impl/src/main/java/org/apache/safeguard/impl/FailsafeExecutionManager.java b/safeguard-impl/src/main/java/org/apache/safeguard/impl/FailsafeExecutionManager.java
index 178a381..db57b3f 100644
--- a/safeguard-impl/src/main/java/org/apache/safeguard/impl/FailsafeExecutionManager.java
+++ b/safeguard-impl/src/main/java/org/apache/safeguard/impl/FailsafeExecutionManager.java
@@ -27,6 +27,8 @@
import org.apache.safeguard.impl.circuitbreaker.FailsafeCircuitBreakerManager;
import org.apache.safeguard.impl.config.MicroprofileAnnotationMapper;
import org.apache.safeguard.impl.executionPlans.ExecutionPlanFactory;
+import org.apache.safeguard.impl.executorService.DefaultExecutorServiceProvider;
+import org.apache.safeguard.impl.executorService.ExecutorServiceProvider;
import org.apache.safeguard.impl.retry.FailsafeRetryManager;
import javax.enterprise.inject.Vetoed;
@@ -34,6 +36,7 @@
import java.lang.reflect.Method;
import java.time.Duration;
import java.util.concurrent.Callable;
+import java.util.concurrent.Executors;
@Vetoed
public class FailsafeExecutionManager implements ExecutionManager {
@@ -42,13 +45,16 @@
private final CircuitBreakerManager circuitBreakerManager;
private final RetryManager retryManager;
private final ExecutionPlanFactory executionPlanFactory;
+ private final ExecutorServiceProvider executorServiceProvider;
public FailsafeExecutionManager() {
FailsafeCircuitBreakerManager circuitBreakerManager = new FailsafeCircuitBreakerManager();
FailsafeRetryManager retryManager = new FailsafeRetryManager();
BulkheadManagerImpl bulkheadManager = new BulkheadManagerImpl();
this.mapper = MicroprofileAnnotationMapper.getInstance();
- this.executionPlanFactory = new ExecutionPlanFactory(circuitBreakerManager, retryManager, bulkheadManager, mapper);
+ this.executorServiceProvider = new DefaultExecutorServiceProvider(Executors.newScheduledThreadPool(5));
+ this.executionPlanFactory = new ExecutionPlanFactory(circuitBreakerManager, retryManager, bulkheadManager, mapper,
+ executorServiceProvider);
this.circuitBreakerManager = circuitBreakerManager;
this.retryManager = retryManager;
this.bulkheadManager = bulkheadManager;
@@ -56,12 +62,13 @@
public FailsafeExecutionManager(MicroprofileAnnotationMapper mapper, BulkheadManagerImpl bulkheadManager,
FailsafeCircuitBreakerManager circuitBreakerManager, FailsafeRetryManager retryManager,
- ExecutionPlanFactory executionPlanFactory) {
+ ExecutionPlanFactory executionPlanFactory, ExecutorServiceProvider executorServiceProvider) {
this.mapper = mapper;
this.bulkheadManager = bulkheadManager;
this.circuitBreakerManager = circuitBreakerManager;
this.retryManager = retryManager;
this.executionPlanFactory = executionPlanFactory;
+ this.executorServiceProvider = executorServiceProvider;
}
public Object execute(InvocationContext invocationContext) {
diff --git a/safeguard-impl/src/main/java/org/apache/safeguard/impl/cdi/FailsafeExecutionManagerProvider.java b/safeguard-impl/src/main/java/org/apache/safeguard/impl/cdi/FailsafeExecutionManagerProvider.java
index a422fce..37d1cab 100644
--- a/safeguard-impl/src/main/java/org/apache/safeguard/impl/cdi/FailsafeExecutionManagerProvider.java
+++ b/safeguard-impl/src/main/java/org/apache/safeguard/impl/cdi/FailsafeExecutionManagerProvider.java
@@ -19,6 +19,7 @@
package org.apache.safeguard.impl.cdi;
+import org.apache.safeguard.api.ExecutionManager;
import org.apache.safeguard.impl.FailsafeExecutionManager;
import javax.enterprise.context.ApplicationScoped;
@@ -28,6 +29,7 @@
public class FailsafeExecutionManagerProvider {
@Produces
@ApplicationScoped
- private FailsafeExecutionManager failsafeExecutionManager = new FailsafeExecutionManager();
-
+ public ExecutionManager createExecutionManager() {
+ return new FailsafeExecutionManager();
+ }
}
diff --git a/safeguard-impl/src/main/java/org/apache/safeguard/impl/executionPlans/ExecutionPlanFactory.java b/safeguard-impl/src/main/java/org/apache/safeguard/impl/executionPlans/ExecutionPlanFactory.java
index 5c7dd5f..ae5ba7f 100644
--- a/safeguard-impl/src/main/java/org/apache/safeguard/impl/executionPlans/ExecutionPlanFactory.java
+++ b/safeguard-impl/src/main/java/org/apache/safeguard/impl/executionPlans/ExecutionPlanFactory.java
@@ -28,6 +28,7 @@
import org.apache.safeguard.impl.circuitbreaker.FailsafeCircuitBreakerManager;
import org.apache.safeguard.api.config.ConfigFacade;
import org.apache.safeguard.impl.config.MicroprofileAnnotationMapper;
+import org.apache.safeguard.impl.executorService.ExecutorServiceProvider;
import org.apache.safeguard.impl.fallback.FallbackRunner;
import org.apache.safeguard.impl.retry.FailsafeRetryBuilder;
import org.apache.safeguard.impl.retry.FailsafeRetryDefinition;
@@ -52,17 +53,20 @@
private final FailsafeRetryManager retryManager;
private final BulkheadManager bulkheadManager;
private final MicroprofileAnnotationMapper microprofileAnnotationMapper;
+ private final ExecutorServiceProvider executorServiceProvider;
private ConcurrentMap<String, ExecutionPlan> executionPlanMap = new ConcurrentHashMap<>();
private final boolean enableAllMicroProfileFeatures;
public ExecutionPlanFactory(FailsafeCircuitBreakerManager circuitBreakerManager,
FailsafeRetryManager retryManager,
BulkheadManager bulkheadManager,
- MicroprofileAnnotationMapper microprofileAnnotationMapper) {
+ MicroprofileAnnotationMapper microprofileAnnotationMapper,
+ ExecutorServiceProvider executorServiceProvider) {
this.circuitBreakerManager = circuitBreakerManager;
this.retryManager = retryManager;
this.bulkheadManager = bulkheadManager;
this.microprofileAnnotationMapper = microprofileAnnotationMapper;
+ this.executorServiceProvider = executorServiceProvider;
this.enableAllMicroProfileFeatures = this.enableNonFallbacksForMicroProfile();
}
@@ -100,16 +104,17 @@
BulkheadExecutionPlan parent = new BulkheadExecutionPlan(bulkhead);
if (circuitBreaker == null && retryDefinition == null && isAsync) {
if (timeout == null) {
- parent.setChild(new AsyncOnlyExecutionPlan(null));
+ parent.setChild(new AsyncOnlyExecutionPlan(executorServiceProvider.getExecutorService()));
} else {
- parent.setChild(new AsyncTimeoutExecutionPlan(timeout, Executors.newFixedThreadPool(5)));
+ parent.setChild(new AsyncTimeoutExecutionPlan(timeout, executorServiceProvider.getExecutorService()));
}
} else if (circuitBreaker == null && retryDefinition == null && timeout != null) {
// then its just timeout
- parent.setChild(new AsyncTimeoutExecutionPlan(timeout, Executors.newFixedThreadPool(5)));
+ parent.setChild(new AsyncTimeoutExecutionPlan(timeout, executorServiceProvider.getExecutorService()));
} else {
if (isAsync || timeout != null) {
- parent.setChild(new AsyncFailsafeExecutionPlan(retryDefinition, circuitBreaker, fallbackRunner, Executors.newScheduledThreadPool(5), timeout));;
+ parent.setChild(new AsyncFailsafeExecutionPlan(retryDefinition, circuitBreaker, fallbackRunner,
+ executorServiceProvider.getScheduledExecutorService(), timeout));;
} else if(circuitBreaker == null && retryDefinition == null && fallbackRunner == null) {
parent.setChild(new BasicExecutionPlan());
} else if(circuitBreaker == null && retryDefinition == null) {
diff --git a/safeguard-impl/src/main/java/org/apache/safeguard/impl/executorService/DefaultExecutorServiceProvider.java b/safeguard-impl/src/main/java/org/apache/safeguard/impl/executorService/DefaultExecutorServiceProvider.java
new file mode 100644
index 0000000..9d2d615
--- /dev/null
+++ b/safeguard-impl/src/main/java/org/apache/safeguard/impl/executorService/DefaultExecutorServiceProvider.java
@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.safeguard.impl.executorService;
+
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.ScheduledExecutorService;
+
+public class DefaultExecutorServiceProvider implements ExecutorServiceProvider {
+ private final ScheduledExecutorService executorService;
+
+ public DefaultExecutorServiceProvider(ScheduledExecutorService executorService) {
+ this.executorService = executorService;
+ }
+
+ @Override
+ public ExecutorService getExecutorService() {
+ return executorService;
+ }
+
+ @Override
+ public ScheduledExecutorService getScheduledExecutorService() {
+ return executorService;
+ }
+}
diff --git a/safeguard-impl/src/main/java/org/apache/safeguard/impl/executorService/ExecutorServiceProvider.java b/safeguard-impl/src/main/java/org/apache/safeguard/impl/executorService/ExecutorServiceProvider.java
new file mode 100644
index 0000000..55b7694
--- /dev/null
+++ b/safeguard-impl/src/main/java/org/apache/safeguard/impl/executorService/ExecutorServiceProvider.java
@@ -0,0 +1,31 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.safeguard.impl.executorService;
+
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.ScheduledExecutorService;
+
+/**
+ * Wraps the look up of an ExecutorService to handle SE and EE cases
+ */
+public interface ExecutorServiceProvider {
+ ExecutorService getExecutorService();
+ ScheduledExecutorService getScheduledExecutorService();
+}
