2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 - 2019 Bell Canada, Deutsche Telekom.
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.so.client.cds;
23 import io.grpc.ManagedChannel;
24 import io.grpc.internal.DnsNameResolverProvider;
25 import io.grpc.internal.PickFirstLoadBalancerProvider;
26 import io.grpc.netty.GrpcSslContexts;
27 import io.grpc.netty.NettyChannelBuilder;
28 import java.security.KeyStore;
29 import java.security.KeyStoreException;
30 import java.security.NoSuchAlgorithmException;
31 import java.util.concurrent.CountDownLatch;
32 import javax.net.ssl.SSLException;
33 import javax.net.ssl.TrustManagerFactory;
34 import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
35 import org.onap.so.client.KeyStoreLoader;
36 import org.onap.so.client.PreconditionFailedException;
37 import org.onap.so.client.RestPropertiesLoader;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
43 * The CDS processing client is using gRPC for communication between SO and CDS. That communication is configured to use
44 * a streaming approach, meaning that client can send an event to which server can reply will multiple sub-responses,
45 * until full completion of the processing.
48 * In order for the caller to manage the callback, it is the responsibility of the caller to implement and provide a
49 * {@link CDSProcessingListener} so received messages can be handled appropriately.
52 * Here is an example of implementation of such listener:
55 * new CDSProcessingListener {
58 * public void onMessage(ExecutionServiceOutput message) {
59 * log.info("Received notification from CDS: {}", message);
63 * public void onError(Throwable t) {
64 * Status status = Status.fromThrowable(t);
65 * log.error("Failed processing blueprint {}", status, t);
70 public class CDSProcessingClient implements AutoCloseable {
72 private static final Logger log = LoggerFactory.getLogger(CDSProcessingClient.class);
74 private ManagedChannel channel;
75 private CDSProcessingHandler handler;
77 public CDSProcessingClient(final CDSProcessingListener listener) {
78 CDSProperties props = RestPropertiesLoader.getInstance().getNewImpl(CDSProperties.class);
80 throw new PreconditionFailedException(
81 "No RestProperty.CDSProperties implementation found on classpath, can't create client.");
83 NettyChannelBuilder builder = NettyChannelBuilder.forAddress(props.getHost(), props.getPort())
84 .nameResolverFactory(new DnsNameResolverProvider())
85 .loadBalancerFactory(new PickFirstLoadBalancerProvider());
86 if (props.getUseSSL()) {
87 log.info("Configure SSL connection");
88 KeyStore ks = KeyStoreLoader.getKeyStore();
90 log.error("Can't load KeyStore");
91 throw new RuntimeException("Can't load KeyStore to create secure channel");
94 TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
96 builder.sslContext(GrpcSslContexts.forClient().trustManager(tmf).build());
97 } catch (NoSuchAlgorithmException e) {
98 log.error("Can't get default TrustManager algorithm");
99 throw new RuntimeException(e);
100 } catch (KeyStoreException e) {
101 log.error("TrustManagerFactory initialization failed");
102 throw new RuntimeException(e);
103 } catch (SSLException e) {
104 log.error("SslContext build error");
105 throw new RuntimeException(e);
108 if (props.getUseBasicAuth()) {
109 log.info("Configure Basic authentication");
110 builder.intercept(new BasicAuthClientInterceptor(props)).usePlaintext();
112 this.channel = builder.build();
113 this.handler = new CDSProcessingHandler(listener);
114 log.info("CDSProcessingClient started");
117 CDSProcessingClient(final ManagedChannel channel, final CDSProcessingHandler handler) {
118 this.channel = channel;
119 this.handler = handler;
123 * Sends a request to the CDS backend micro-service.
125 * The caller will be returned a CountDownLatch that can be used to define how long the processing can wait. The
126 * CountDownLatch is initiated with just 1 count. When the client receives an #onCompleted callback, the counter
129 * It is the user responsibility to close the client.
131 * @param input request to send
132 * @return CountDownLatch instance that can be use to #await for completeness of processing
134 public CountDownLatch sendRequest(ExecutionServiceInput input) {
135 return handler.process(input, channel);
139 public void close() {
140 if (channel != null) {
143 log.info("CDSProcessingClient stopped");