summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/dcaegen2/services/pmmapper/datarouter/DataRouterSubscriber.java
blob: fc623bd2fac6b50c6bd1aa457c638cd65c2dce34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.dcaegen2.services.pmmapper.datarouter;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import io.undertow.util.HeaderValues;
import lombok.Data;
import lombok.NonNull;

import org.onap.dcaegen2.services.pmmapper.exceptions.NoMetadataException;
import org.onap.dcaegen2.services.pmmapper.exceptions.TooManyTriesException;
import org.onap.dcaegen2.services.pmmapper.model.EventMetadata;
import org.onap.dcaegen2.services.pmmapper.model.MapperConfig;
import org.onap.dcaegen2.services.pmmapper.model.Event;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.util.StatusCodes;

import org.onap.dcaegen2.services.pmmapper.utils.HttpServerExchangeAdapter;
import org.onap.dcaegen2.services.pmmapper.utils.RequiredFieldDeserializer;
import org.onap.logging.ref.slf4j.ONAPLogAdapter;
import org.onap.logging.ref.slf4j.ONAPLogConstants;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.nio.charset.StandardCharsets;
import java.time.Instant;
import java.util.Map;
import java.util.Optional;
import java.util.Random;
import java.util.UUID;

/**
 * Subscriber for events sent from data router
 * Provides an undertow HttpHandler to be used as an endpoint for data router to send events to.
 */
@Data
public class DataRouterSubscriber implements HttpHandler {
    private static final ONAPLogAdapter logger = new ONAPLogAdapter(LoggerFactory.getLogger(DataRouterSubscriber.class));
    private static final int NUMBER_OF_ATTEMPTS = 5;
    private static final int DEFAULT_TIMEOUT = 2000;
    private static final int MAX_JITTER = 50;

    private static final String METADATA_HEADER = "X-ATT-DR-META";
    private static final String BAD_METADATA_MESSAGE = "Malformed Metadata.";
    private static final String NO_METADATA_MESSAGE = "Missing Metadata.";

    private boolean limited = false;
    private Random jitterGenerator;
    private Gson metadataBuilder;
    @NonNull
    private EventReceiver eventReceiver;

    /**
     * @param eventReceiver receiver for any inbound events.
     */
    public DataRouterSubscriber(EventReceiver eventReceiver) {
        this.eventReceiver = eventReceiver;
        this.jitterGenerator = new Random();
        this.metadataBuilder = new GsonBuilder().registerTypeAdapter(EventMetadata.class, new RequiredFieldDeserializer<EventMetadata>())
                .create();
    }

    /**
     * Starts data flow by subscribing to data router through bus controller.
     *
     * @param config configuration object containing bus controller endpoint for subscription and
     *               all non constant configuration for subscription through this endpoint.
     * @throws TooManyTriesException in the event that timeout has occurred several times.
     */
    public void start(MapperConfig config) throws TooManyTriesException, InterruptedException {
        try {
            logger.unwrap().info(ONAPLogConstants.Markers.ENTRY, "Starting subscription to DataRouter");
            subscribe(NUMBER_OF_ATTEMPTS, DEFAULT_TIMEOUT, config);
        } finally {
            logger.unwrap().info(ONAPLogConstants.Markers.EXIT, "");
        }
    }

    private HttpURLConnection getBusControllerConnection(MapperConfig config, int timeout) throws IOException {
        HttpURLConnection connection = (HttpURLConnection) config.getBusControllerSubscriptionUrl()
                .openConnection();
        connection.setRequestMethod("POST");
        connection.setConnectTimeout(timeout);
        connection.setReadTimeout(timeout);
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setDoOutput(true);

        final UUID invocationID = logger.invoke(ONAPLogConstants.InvocationMode.SYNCHRONOUS);
        final UUID requestID = UUID.randomUUID();
        connection.setRequestProperty(ONAPLogConstants.Headers.REQUEST_ID, requestID.toString());
        connection.setRequestProperty(ONAPLogConstants.Headers.INVOCATION_ID, invocationID.toString());
        connection.setRequestProperty(ONAPLogConstants.Headers.PARTNER_NAME, MapperConfig.CLIENT_NAME);

        return connection;
    }

    private JsonObject getBusControllerSubscribeBody(MapperConfig config) {
        JsonObject subscriberObj = new JsonObject();
        subscriberObj.addProperty("dcaeLocationName", config.getDcaeLocation());
        subscriberObj.addProperty("deliveryURL", config.getBusControllerDeliveryUrl());
        subscriberObj.addProperty("feedId", config.getBusControllerFeedId());
        subscriberObj.addProperty("lastMod", Instant.now().toString());
        subscriberObj.addProperty("username", config.getBusControllerUserName());
        subscriberObj.addProperty("userpwd", config.getBusControllerPassword());
        return subscriberObj;
    }

    private void subscribe(int attempts, int timeout, MapperConfig config) throws TooManyTriesException, InterruptedException {
        int subResponse = 504;
        String subMessage = "";
        try {
            HttpURLConnection connection = getBusControllerConnection(config, timeout);

            try (OutputStream bodyStream = connection.getOutputStream();
                 OutputStreamWriter bodyWriter = new OutputStreamWriter(bodyStream, StandardCharsets.UTF_8)) {
                bodyWriter.write(getBusControllerSubscribeBody(config).toString());
            }
            subResponse = connection.getResponseCode();
            subMessage = connection.getResponseMessage();
        } catch (IOException e) {
            logger.unwrap().error("Timeout Failure:", e);
        }
        logger.unwrap().info("Request to bus controller executed with Response Code: '{}' and Response Event: '{}'.", subResponse, subMessage);
        if (subResponse >= 300 && attempts > 1) {
            Thread.sleep(timeout);
            subscribe(--attempts, (timeout * 2) + jitterGenerator.nextInt(MAX_JITTER), config);
        } else if (subResponse >= 300) {
            throw new TooManyTriesException("Failed to subscribe within appropriate amount of attempts");
        }
    }

    /**
     * Receives inbound requests, verifies that required headers are valid
     * and passes an Event onto the eventReceiver.
     * The forwarded httpServerExchange response is the responsibility of the eventReceiver.
     *
     * @param httpServerExchange inbound http server exchange.
     */
    @Override
    public void handleRequest(HttpServerExchange httpServerExchange) {
        try{
            logger.entering(new HttpServerExchangeAdapter(httpServerExchange));
            if (limited) {
                httpServerExchange.setStatusCode(StatusCodes.SERVICE_UNAVAILABLE)
                        .getResponseSender()
                        .send(StatusCodes.SERVICE_UNAVAILABLE_STRING);
            } else {
                try {
                    String metadataAsString = Optional.of(httpServerExchange.getRequestHeaders()
                            .get(METADATA_HEADER))
                            .map((HeaderValues headerValues) -> headerValues.get(0))
                            .orElseThrow(() -> new NoMetadataException("Metadata Not found"));
                    Map<String,String> mdc = MDC.getCopyOfContextMap();
                    EventMetadata metadata = metadataBuilder.fromJson(metadataAsString, EventMetadata.class);
                    httpServerExchange.getRequestReceiver()
                            .receiveFullString((callbackExchange, body) -> {
                                httpServerExchange.dispatch(() -> eventReceiver.receive(new Event(callbackExchange, body, metadata, mdc)));
                            });
                } catch (NoMetadataException exception) {
                    logger.unwrap().info("Bad Request: no metadata found under '{}' header.", METADATA_HEADER, exception);
                    httpServerExchange.setStatusCode(StatusCodes.BAD_REQUEST)
                            .getResponseSender()
                            .send(NO_METADATA_MESSAGE);
                } catch (JsonParseException exception) {
                    logger.unwrap().info("Bad Request: Failure to parse metadata", exception);
                    httpServerExchange.setStatusCode(StatusCodes.BAD_REQUEST)
                            .getResponseSender()
                            .send(BAD_METADATA_MESSAGE);
                }
            }
        } finally {
            logger.exiting();
        }
    }
}