aboutsummaryrefslogtreecommitdiffstats
path: root/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractAuditLogFilter.java
blob: ce2f44899b67019cdcccd1897d0c04d91b6757c9 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP - Logging
 * ================================================================================
 * Copyright (C) 2019 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.logging.filter.base;

import javax.servlet.http.HttpServletRequest;
import org.onap.logging.ref.slf4j.ONAPLogConstants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

public abstract class AbstractAuditLogFilter<GenericRequest, GenericResponse> extends MDCSetup {
    protected static final Logger logger = LoggerFactory.getLogger(AbstractAuditLogFilter.class);

    protected void pre(SimpleMap headers, GenericRequest request, HttpServletRequest httpServletRequest) {
        try {
            String requestId = getRequestId(headers);
            MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);
            setInvocationId(headers);
            setServiceName(request);
            setMDCPartnerName(headers);
            setServerFQDN();
            setClientIPAddress(httpServletRequest);
            setInstanceID();
            setEntryTimeStamp();
            MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
            additionalPreHandling(request);
            setLogTimestamp();
            setElapsedTime();
            logger.info(ONAPLogConstants.Markers.ENTRY, "Entering");
        } catch (Exception e) {
            logger.warn("Error in AbstractInboundFilter pre", e);
        }
    }

    protected void post(GenericResponse response) {
        try {
            int responseCode = getResponseCode(response);
            setResponseStatusCode(responseCode);
            MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(responseCode));
            setResponseDescription(responseCode);
            setLogTimestamp();
            setElapsedTime();
            logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
            additionalPostHandling(response);
        } catch (Exception e) {
            logger.warn("Error in AbstractInboundFilter post", e);
        } finally {
            MDC.clear();
        }
    }

    protected abstract int getResponseCode(GenericResponse response);

    protected abstract void setServiceName(GenericRequest request);

    protected void additionalPreHandling(GenericRequest request) {
        // override to add additional pre handling
    }

    protected void additionalPostHandling(GenericResponse response) {
        // override to add additional post handling
    }

}