2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.controlloop.actorserviceprovider.impl;
24 import java.util.concurrent.TimeUnit;
25 import java.util.function.BiFunction;
27 import org.onap.policy.common.endpoints.http.client.HttpClient;
28 import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
29 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
30 import org.onap.policy.common.parameters.ValidationResult;
31 import org.onap.policy.controlloop.actorserviceprovider.Operation;
32 import org.onap.policy.controlloop.actorserviceprovider.Util;
33 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
34 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams;
35 import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
38 * Operator that uses HTTP. The operator's parameters must be an {@link HttpParams}.
41 public abstract class HttpOperator extends OperatorPartial {
43 private HttpClient client;
46 * Default timeout, in milliseconds, if none specified in the request.
48 private long timeoutMs;
51 * URI path for this particular operation. Includes a leading "/".
57 * Constructs the object.
59 * @param actorName name of the actor with which this operator is associated
60 * @param name operation name
62 public HttpOperator(String actorName, String name) {
63 super(actorName, name);
67 * Makes an operator that will construct operations.
69 * @param <T> response type
70 * @param actorName actor name
71 * @param operation operation name
72 * @param operationMaker function to make an operation
73 * @return a new operator
75 public static <T> HttpOperator makeOperator(String actorName, String operation,
76 BiFunction<ControlLoopOperationParams, HttpOperator, HttpOperation<T>> operationMaker) {
78 return new HttpOperator(actorName, operation) {
80 public Operation buildOperation(ControlLoopOperationParams params) {
81 return operationMaker.apply(params, this);
87 * Translates the parameters to an {@link HttpParams} and then extracts the relevant
91 protected void doConfigure(Map<String, Object> parameters) {
92 HttpParams params = Util.translate(getFullName(), parameters, HttpParams.class);
93 ValidationResult result = params.validate(getFullName());
94 if (!result.isValid()) {
95 throw new ParameterValidationRuntimeException("invalid parameters", result);
98 client = getClientFactory().get(params.getClientName());
99 path = params.getPath();
100 timeoutMs = TimeUnit.MILLISECONDS.convert(params.getTimeoutSec(), TimeUnit.SECONDS);
103 // these may be overridden by junit tests
105 protected HttpClientFactory getClientFactory() {
106 return HttpClientFactoryInstance.getClientFactory();