summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/sdc/common/onaplog/OnapLoggerAudit.java
blob: fefcd2589f5fd1c42cf68bcacceda870643ba60b (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
/*-
 * ============LICENSE_START=======================================================
 * sdc-dcae-d-dt-be-property
 * ================================================================================
 * Copyright (C) 2017 - 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.sdc.common.onaplog;

import org.onap.sdc.common.onaplog.enums.LogMarkers;
import org.onap.sdc.common.onaplog.enums.OnapLoggerErrorCode;
import org.onap.sdc.common.onaplog.enums.Severity;
import org.onap.sdc.common.onaplog.enums.StatusCode;
import org.onap.sdc.common.onaplog.interfaces.IOnapMdcWrapper;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.slf4j.MarkerFactory;

public class OnapLoggerAudit extends OnapLoggerBase {
    private static OnapLoggerAudit instanceLoggerAudit = OnapLoggerFactory.getLogger(OnapLoggerAudit.class);

    OnapLoggerAudit(IOnapMdcWrapper onapMDCWrapper) {
        super (onapMDCWrapper, MarkerFactory.getMarker(LogMarkers.AUDIT_MARKER.text()));
        logger = LoggerFactory.getLogger(this.getClass().getName());
   }

   OnapLoggerAudit(){}

    public static OnapLoggerAudit getInstance() {
        return instanceLoggerAudit;
    }

    @Override
    public OnapLoggerAudit startTimer() {
        return (OnapLoggerAudit) super.startTimer();
    }

    public OnapLoggerAudit stopTimer() {
        onapMDCWrapper.stopTimer();
        return this;
    }

    // automatic parameter this is optional
    public OnapLoggerAudit setAutoServerFQDN(String serverFQDN) {
        onapMDCWrapper.setAutoServerFQDN(serverFQDN);
        return this;
    }

    // automatic parameter this is optional
    public OnapLoggerAudit setAutoServerIPAddress(String serverIPAddress) {
        onapMDCWrapper.setAutoServerIPAddress(serverIPAddress);
        return this;
    }

    public OnapLoggerAudit setInstanceUUID(String instanceUUID) {
        onapMDCWrapper.setInstanceUUID(instanceUUID);
        return this;
    }

    public OnapLoggerAudit setOptClassName(String className) {
        MDC.put("ClassName", className);
        return this;
    }

    public OnapLoggerAudit setOptProcessKey(String processKey) {
        onapMDCWrapper.setProcessKey(processKey);
        return this;
    }

    public OnapLoggerAudit setOptAlertSeverity(Severity alertSeverity) {
        onapMDCWrapper.setAlertSeverity(alertSeverity);
        return this;
    }

    // onap optional parameter
    public OnapLoggerAudit setOptCustomField1(String customField1) {
        onapMDCWrapper.setOptCustomField1(customField1);
        return this;
    }

    // onap optional parameter
    public OnapLoggerAudit setOptCustomField2(String customField2) {
        onapMDCWrapper.setOptCustomField2(customField2);
        return this;
    }

    // onap optional parameter
    public OnapLoggerAudit setOptCustomField3(String customField3) {
        onapMDCWrapper.setOptCustomField3(customField3);
        return this;
    }

    public OnapLoggerAudit setOptCustomField4(String customField4) {
        onapMDCWrapper.setOptCustomField4(customField4);
        return this;
    }

    @Override
    public OnapLoggerAudit setKeyRequestId(String keyRequestId) {
        return (OnapLoggerAudit) super.setKeyRequestId(keyRequestId);
    }

    public OnapLoggerAudit setRemoteHost(String remoteHost) {
        onapMDCWrapper.setRemoteHost(remoteHost);
        return this;
    }

    public OnapLoggerAudit setServiceName(String serviceName) {
        onapMDCWrapper.setServiceName(serviceName);
        return this;
    }

    public OnapLoggerAudit setStatusCode(String statusCode) {
        // status code is either success (COMPLETE) or failure (ERROR) of the request.
        String respStatus = Integer.parseInt(statusCode) / 100 == 2 ?
                StatusCode.COMPLETE.getText() : StatusCode.ERROR.getText();
        onapMDCWrapper.setStatusCode(respStatus);
        return this;
    }

    public OnapLoggerAudit setPartnerName(String partnerName) {
        onapMDCWrapper.setPartnerName(partnerName);
        return this;
    }

    public OnapLoggerAudit setResponseCode(OnapLoggerErrorCode responseCode) {
        onapMDCWrapper.setResponseCode(responseCode.getErrorCode());
        return this;
    }

    public OnapLoggerAudit setResponseDesc(String responseDesc) {
        onapMDCWrapper.setResponseDesc(responseDesc);
        return this;
    }

    public OnapLoggerAudit setOptServiceInstanceId(String serviceInstanceId) {
        onapMDCWrapper.setServiceInstanceId(serviceInstanceId);
        return this;
    }

    @Override
    public OnapLoggerAudit clear() {
        return (OnapLoggerAudit) super.clear();
    }

    @Override
    public void initializeMandatoryFields() {

        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_BEGIN_TIMESTAMP);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_END_TIMESTAMP);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_KEY_REQUEST_ID);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_SERVICE_NAME);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_PARTNER_NAME);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_STATUS_CODE);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_RESPONSE_CODE);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_RESPONSE_DESC);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_ELAPSED_TIME);

        //Theoretically Optional, but practically Mandatory
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_SERVER_IP_ADDRESS);
        onapMDCWrapper.setMandatoryField(OnapLogConfiguration.MDC_SERVER_FQDN);

        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_INSTANCE_UUID);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_ALERT_SEVERITY);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_REMOTE_HOST);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_CLASS_NAME);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_PROCESS_KEY);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_OPT_FIELD1);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_OPT_FIELD2);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_OPT_FIELD3);
        onapMDCWrapper.setOptionalField(OnapLogConfiguration.MDC_OPT_FIELD4);
    }
}