aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-be/src/main/java/org/openecomp/sdc/be/auditing/impl/AuditBaseEventFactory.java
blob: 91212ad11e2f396267a63c32d140f89a7a4e89ea (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
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * 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.openecomp.sdc.be.auditing.impl;

import org.apache.commons.lang.StringUtils;
import org.javatuples.Pair;
import org.openecomp.sdc.be.auditing.api.AuditEventFactory;
import org.openecomp.sdc.be.model.User;
import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
import org.openecomp.sdc.common.api.Constants;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
public abstract class AuditBaseEventFactory implements AuditEventFactory {

    private AuditingActionEnum action;

    public AuditBaseEventFactory(AuditingActionEnum action) {
        this.action = Objects.requireNonNull(action);
    }

    public AuditBaseEventFactory() {}

    public AuditingActionEnum getAction() {
        return action;
    }

    public static String buildUserNameExtended(User user) {
        if (user == null) {
            return null;
        }

        StringBuilder builder = new StringBuilder();
        appendIfNotEmpty(user.getUserId(), builder);

        String firstName = replaceNullNameWithEmpty(user.getFirstName());
        String lastName = replaceNullNameWithEmpty(user.getLastName());

        if (appendIfNotEmpty(firstName, builder)) {
            appendIfNotEmpty(lastName, builder, " ");
        }
        else {
            appendIfNotEmpty(lastName, builder);
        }
        appendIfNotEmpty(user.getEmail(), builder);
        appendIfNotEmpty(user.getRole(), builder);

        return builder.toString();
    }

    private static boolean appendIfNotEmpty(String value, StringBuilder builder) {
        return appendIfNotEmpty(value, builder, ", ");
    }

    protected static boolean appendIfNotEmpty(String value, StringBuilder builder, String delimiter) {
        if (StringUtils.isEmpty(value)) {
            return false;
        }
        addDelimiterIfNeeded(builder, delimiter);
        builder.append(value);
        return true;
    }

    private static void addDelimiterIfNeeded(StringBuilder builder, String delimiter) {
        if (builder.length() > 0) {
            builder.append(delimiter);
        }
    }

    protected static String buildUserName(User user) {
        if (user == null || StringUtils.isEmpty(user.getUserId())) {
            return StringUtils.EMPTY;
        }
        StringBuilder sb = new StringBuilder();
        String firstName = replaceNullNameWithEmpty(user.getFirstName());
        if (!firstName.isEmpty()) {
            sb.append(firstName);
            sb.append(" ");
        }
        String lastName = replaceNullNameWithEmpty(user.getLastName());
        if (!lastName.isEmpty()) {
            sb.append(lastName);
        }
        sb.append("(").append(user.getUserId()).append(")");
        return sb.toString();
    }

    private static String buildValue(String value) {
        if (value == null) {
            return StringUtils.EMPTY;
        }
        return value;
    }

    protected static String replaceNullNameWithEmpty(String name) {
        if (name != null && !name.trim().contains(Constants.NULL_STRING)) {
            return name;
        }
        return StringUtils.EMPTY;
    }

    @Override
    //TODO implement in derived classes for ci testing
    public List<Pair<String, String>> getQueryParams() {
        return Collections.emptyList();
    }

    @Override
    public final String getLogMessage() {
       return String.format(getLogPattern(), getLogArgs());
    }

    private Object[] getLogArgs() {
        return Arrays.stream(getLogMessageParams())
                .map(AuditBaseEventFactory::buildValue)
                .toArray(String[]::new);
    }

    public abstract String getLogPattern();

    public abstract String[] getLogMessageParams();




}