From 7a59728f0d4cc0964bed2e4575a8f02de59f385f Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Mon, 24 Feb 2020 15:11:35 -0500 Subject: Add PipelineUtil Issue-ID: POLICY-2385 Signed-off-by: Jim Hahn Change-Id: I7745e8286dd6f086941b979f16b2328bfa066788 --- .../impl/OperationPartial.java | 16 ++++---- .../pipeline/PipelineUtil.java | 48 ++++++++++++++++++++++ .../pipeline/PipelineUtilTest.java | 37 +++++++++++++++++ 3 files changed, 93 insertions(+), 8 deletions(-) create mode 100644 models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtil.java create mode 100644 models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtilTest.java (limited to 'models-interactions') diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/OperationPartial.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/OperationPartial.java index be357b8f3..ff1b46264 100644 --- a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/OperationPartial.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/OperationPartial.java @@ -113,7 +113,7 @@ public abstract class OperationPartial implements Operation { } @Override - public final CompletableFuture start() { + public CompletableFuture start() { // allocate a controller for the entire operation final PipelineControllerFuture controller = new PipelineControllerFuture<>(); @@ -539,7 +539,7 @@ public abstract class OperationPartial implements Operation { * created. If this future is canceled, then all of the futures will be * canceled */ - protected CompletableFuture anyOf( + public CompletableFuture anyOf( @SuppressWarnings("unchecked") Supplier>... futureMakers) { return anyOf(Arrays.asList(futureMakers)); @@ -558,7 +558,7 @@ public abstract class OperationPartial implements Operation { * canceled. Similarly, when this future completes, any incomplete futures * will be canceled */ - protected CompletableFuture anyOf( + public CompletableFuture anyOf( List>> futureMakers) { PipelineControllerFuture controller = new PipelineControllerFuture<>(); @@ -592,7 +592,7 @@ public abstract class OperationPartial implements Operation { * created. If this future is canceled, then all of the futures will be * canceled */ - protected CompletableFuture allOf( + public CompletableFuture allOf( @SuppressWarnings("unchecked") Supplier>... futureMakers) { return allOf(Arrays.asList(futureMakers)); @@ -610,7 +610,7 @@ public abstract class OperationPartial implements Operation { * canceled. Similarly, when this future completes, any incomplete futures * will be canceled */ - protected CompletableFuture allOf( + public CompletableFuture allOf( List>> futureMakers) { PipelineControllerFuture controller = new PipelineControllerFuture<>(); @@ -769,7 +769,7 @@ public abstract class OperationPartial implements Operation { * @param futureMakers functions to make the futures * @return a future to cancel the sequence or await the outcome */ - protected CompletableFuture sequence( + public CompletableFuture sequence( @SuppressWarnings("unchecked") Supplier>... futureMakers) { return sequence(Arrays.asList(futureMakers)); @@ -784,7 +784,7 @@ public abstract class OperationPartial implements Operation { * @return a future to cancel the sequence or await the outcome, or {@code null} if * there were no tasks to perform */ - protected CompletableFuture sequence( + public CompletableFuture sequence( List>> futureMakers) { Queue>> queue = new ArrayDeque<>(futureMakers); @@ -926,7 +926,7 @@ public abstract class OperationPartial implements Operation { * @param operation operation to be updated * @return the updated operation */ - protected OperationOutcome setOutcome(OperationOutcome operation, Throwable thrown) { + public OperationOutcome setOutcome(OperationOutcome operation, Throwable thrown) { PolicyResult result = (isTimeout(thrown) ? PolicyResult.FAILURE_TIMEOUT : PolicyResult.FAILURE_EXCEPTION); return setOutcome(operation, result); } diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtil.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtil.java new file mode 100644 index 000000000..3854fb29a --- /dev/null +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtil.java @@ -0,0 +1,48 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.controlloop.actorserviceprovider.pipeline; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ForkJoinPool; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.OperatorConfig; + +/** + * Utility class providing anyOf(), allOf(), sequence() to actor clients. + */ +public class PipelineUtil extends OperationPartial { + + /** + * Constructs the utility. + * + * @param params utility parameters + */ + public PipelineUtil(ControlLoopOperationParams params) { + super(params, new OperatorConfig(ForkJoinPool.commonPool())); + } + + @Override + public CompletableFuture start() { + throw new UnsupportedOperationException("cannot start() pipeline utility"); + } +} diff --git a/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtilTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtilTest.java new file mode 100644 index 000000000..fbcacbf30 --- /dev/null +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/pipeline/PipelineUtilTest.java @@ -0,0 +1,37 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.controlloop.actorserviceprovider.pipeline; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +import org.junit.Test; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; + +public class PipelineUtilTest { + + @Test + public void testPipelineUtil() { + ControlLoopOperationParams params = ControlLoopOperationParams.builder().build(); + PipelineUtil util = new PipelineUtil(params); + + assertThatThrownBy(() -> util.start()).isInstanceOf(UnsupportedOperationException.class); + } +} -- cgit 1.2.3-korg