summaryrefslogtreecommitdiffstats
path: root/catalog-be/src/main/java/org/openecomp/sdc/be/auditing/impl/AuditingManager.java
blob: aa5afa4a8ef336f441dd2b8d87f6cdaad2f5329e (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
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 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.openecomp.sdc.be.auditing.impl;

import java.util.EnumMap;
import java.util.Map.Entry;

import javax.annotation.Resource;

import org.openecomp.sdc.be.auditing.api.IAuditingManager;
import org.openecomp.sdc.be.config.ConfigurationManager;
import org.openecomp.sdc.be.dao.api.ActionStatus;
import org.openecomp.sdc.be.dao.cassandra.AuditCassandraDao;
import org.openecomp.sdc.be.dao.cassandra.CassandraOperationStatus;
import org.openecomp.sdc.be.dao.impl.AuditingDao;
import org.openecomp.sdc.be.resources.data.auditing.AuditRecordFactory;
import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
import org.openecomp.sdc.be.resources.data.auditing.AuditingGenericEvent;
import org.openecomp.sdc.common.api.Constants;
import org.openecomp.sdc.common.datastructure.AuditingFieldsKeysEnum;
import org.openecomp.sdc.common.util.ThreadLocalsHolder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component("auditingManager")
public class AuditingManager implements IAuditingManager {

	private static Logger log = LoggerFactory.getLogger(AuditingManager.class.getName());

	@Resource
	private AuditingDao auditingDao;
	@Autowired
	private AuditCassandraDao cassandraDao;

	@Override
	public void auditEvent(EnumMap<AuditingFieldsKeysEnum, Object> auditingFields) {
		try {
			boolean disableAudit = ConfigurationManager.getConfigurationManager().getConfiguration().isDisableAudit();
			if (disableAudit) {
				return;
			}
			// Adding UUID from thread local
			auditingFields.put(AuditingFieldsKeysEnum.AUDIT_REQUEST_ID, ThreadLocalsHolder.getUuid());

			Object status = auditingFields.get(AuditingFieldsKeysEnum.AUDIT_STATUS);
			auditingFields.put(AuditingFieldsKeysEnum.AUDIT_STATUS, String.valueOf(status));

			// normalizing empty string values - US471661
			normalizeEmptyAuditStringValues(auditingFields);

			// Format modifier
			formatModifier(auditingFields);

			// Format user
			formatUser(auditingFields);

			// Logging the event
			AuditingLogFormatUtil.logAuditEvent(auditingFields);

			// Determining the type of the auditing data object
			AuditingActionEnum actionEnum = AuditingActionEnum.getActionByName((String) auditingFields.get(AuditingFieldsKeysEnum.AUDIT_ACTION));
			log.info("audit event {} of type {}", actionEnum.getName(), actionEnum.getAuditingEsType());
			ActionStatus addRecordStatus = auditingDao.addRecord(auditingFields, actionEnum.getAuditingEsType());
			if (!addRecordStatus.equals(ActionStatus.OK)) {
				log.warn("Failed to persist auditing event: {}", addRecordStatus.name());
			}

			AuditingGenericEvent recordForCassandra = AuditRecordFactory.createAuditRecord(auditingFields);
			if (recordForCassandra != null) {
				CassandraOperationStatus result = cassandraDao.saveRecord(recordForCassandra);
				if (!result.equals(CassandraOperationStatus.OK)) {
					log.warn("Failed to persist to cassandra auditing event: {}", addRecordStatus.name());
				}
			}

		} catch (Exception e) {
			// Error during auditing shouldn't terminate flow
			log.warn("Error during auditEvent: {}", e);
		}
	}

	private void formatUser(EnumMap<AuditingFieldsKeysEnum, Object> auditingFields) {
		if (auditingFields.get(AuditingFieldsKeysEnum.AUDIT_USER_UID) != null) {
			String userDetails = (String) auditingFields.get(AuditingFieldsKeysEnum.AUDIT_USER_UID);

			String user = AuditingLogFormatUtil.getUser(userDetails);
			auditingFields.put(AuditingFieldsKeysEnum.AUDIT_USER_UID, user);
		}
	}

	private void formatModifier(EnumMap<AuditingFieldsKeysEnum, Object> auditingFields) {
		String modifier = AuditingLogFormatUtil.getModifier((String) auditingFields.get(AuditingFieldsKeysEnum.AUDIT_MODIFIER_NAME), (String) auditingFields.get(AuditingFieldsKeysEnum.AUDIT_MODIFIER_UID));
		auditingFields.put(AuditingFieldsKeysEnum.AUDIT_MODIFIER_UID, modifier);
		auditingFields.remove(AuditingFieldsKeysEnum.AUDIT_MODIFIER_NAME);
	}

	private void normalizeEmptyAuditStringValues(EnumMap<AuditingFieldsKeysEnum, Object> auditingFields) {
		for (Entry<AuditingFieldsKeysEnum, Object> auditingEntry : auditingFields.entrySet()) {
			if (auditingEntry.getKey().getValueClass().equals(String.class)) {
				String auditingValue = (String) auditingEntry.getValue();
				boolean isEmpty = false;
				if (auditingValue != null) {
					String trimmedValue = auditingValue.trim();
					if ((trimmedValue.equals(Constants.EMPTY_STRING)) || trimmedValue.equals(Constants.NULL_STRING) || trimmedValue.equals(Constants.DOUBLE_NULL_STRING)) {
						isEmpty = true;
					}
				} else {// is null
					isEmpty = true;
				}
				// Normalizing to ""
				if (isEmpty) {
					auditingEntry.setValue(Constants.EMPTY_STRING);
				}
			}
		}
	}
}