summaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/servlet/ContextTracker.java
blob: 2334f373bc803c7d8ffa67c211d0522497762351 (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
/*
 * Copyright © 2016-2018 European Support Limited
 *
 * 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.
 */

package org.openecomp.sdc.logging.servlet;

import java.util.Objects;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import org.openecomp.sdc.logging.api.ContextData;
import org.openecomp.sdc.logging.api.LoggingContext;

/**
 * Populates the context before a request is processed, and cleans it after the request has been processed.
 *
 * @author evitaliy
 * @since 31 Jul 2018
 */
public class ContextTracker implements Tracker {

    private final HttpHeader partnerNameHeaders;
    private final HttpHeader requestIdHeaders;

    /**
     * Constructs tracker to handle required logging context in Servlet-based applications. Refer to ONAP logging
     * guidelines for fields required to be put on logging context.
     *
     * @param partnerNameHeaders HTTP headers to check for a partner name, cannot be null
     * @param requestIdHeaders   HTTP headers to check for a request ID, cannot be null
     */
    public ContextTracker(HttpHeader partnerNameHeaders, HttpHeader requestIdHeaders) {
        this.partnerNameHeaders = Objects.requireNonNull(partnerNameHeaders);
        this.requestIdHeaders = Objects.requireNonNull(requestIdHeaders);
    }

    @Override
    public void preRequest(HttpServletRequest request) {

        LoggingContext.clear();

        String serviceName = ServiceNameFormatter.format(request);
        String requestId = requestIdHeaders.getAny(request::getHeader).orElse(UUID.randomUUID().toString());
        ContextData.ContextDataBuilder contextBuilder =
                ContextData.builder().serviceName(serviceName).requestId(requestId);

        partnerNameHeaders.getAny(request::getHeader).ifPresent(contextBuilder::partnerName);
        LoggingContext.put(contextBuilder.build());
    }

    @Override
    public void postRequest(RequestProcessingResult result) {
        LoggingContext.clear();
    }
}