summaryrefslogtreecommitdiffstats
path: root/common-app-api/src/main/java/org/openecomp/sdc/common/config/AbsEcompErrorManager.java
blob: 6a54071f4284614b876507dbecfef9c88b34a90c (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
/*-
 * ============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.common.config;

import java.util.Formatter;
import java.util.IllegalFormatException;
import java.util.Locale;

import org.apache.commons.lang3.StringUtils;
import org.openecomp.sdc.common.config.EcompErrorConfiguration.EcompAlarmSeverity;
import org.openecomp.sdc.common.config.EcompErrorConfiguration.EcompErrorSeverity;
import org.openecomp.sdc.common.config.EcompErrorConfiguration.EcompErrorType;

import com.jcabi.aspects.Loggable;

@Loggable(prepend = true, value = Loggable.TRACE, trim = false)
public abstract class AbsEcompErrorManager implements IEcompErrorManager {

	public static final String PARAM_STR = "%s";

	public abstract IEcompConfigurationManager getConfigurationManager();

	@Deprecated
	@Override
	public void processEcompError(EcompErrorName ecompErrorName, String ecompErrorContext,
			String... descriptionParams) {

		/*
		 * //Getting the relevant config manager IEcompConfigurationManager
		 * configurationManager = getConfigurationManager();
		 * 
		 * //Getting the error by name EcompErrorInfo ecompErrorInfo =
		 * configurationManager.getEcompErrorConfiguration().getEcompErrorInfo(
		 * ecompErrorName.name());
		 * 
		 * if (ecompErrorInfo != null){ ecompErrorInfo =
		 * setDescriptionParams(ecompErrorInfo, ecompErrorName.name(),
		 * descriptionParams); EcompErrorLogUtil.logEcompError(ecompErrorName,
		 * ecompErrorInfo, ecompErrorContext); } else {
		 * EcompErrorLogUtil.logEcompError(EcompErrorName.EcompErrorNotFound,
		 * getErrorInfoForUnknownErrorName(ecompErrorName.name()),
		 * ecompErrorContext); }
		 */

	}

	private EcompErrorInfo setDescriptionParams(EcompErrorInfo ecompErrorInfo, String ecompErrorName,
			String... descriptionParams) {
		String description = ecompErrorInfo.getDescription();
		// Counting number of params in description
		int countMatches = StringUtils.countMatches(description, PARAM_STR);
		// Catching cases when there are more params passed than there are in
		// the description (formatter will ignore extra params and won't throw
		// exception)
		if (countMatches != descriptionParams.length) {
			return getErrorInfoForDescriptionParamsMismatch(ecompErrorName);
		}
		// Setting params of the description if any
		StringBuilder sb = new StringBuilder();
		Formatter formatter = new Formatter(sb, Locale.US);
		try {
			formatter.format(description, (Object[]) descriptionParams).toString();
			ecompErrorInfo.setDescription(formatter.toString());
		} catch (IllegalFormatException e) {
			// Number of passed params doesn't match number of params in config
			// file
			return getErrorInfoForDescriptionParamsMismatch(ecompErrorName);
		} finally {
			formatter.close();
		}
		return ecompErrorInfo;
	}

	private EcompErrorInfo getErrorInfoForUnknownErrorName(String ecompErrorName) {
		EcompErrorInfo ecompErrorInfo = new EcompErrorInfo();
		ecompErrorInfo.setCode(EcompErrorConfiguration.ECODE_PREFIX + "3001");
		ecompErrorInfo.setType(EcompErrorType.CONFIG_ERROR.name());
		ecompErrorInfo.setSeverity(EcompErrorSeverity.ERROR.name());
		ecompErrorInfo.setAlarmSeverity(EcompAlarmSeverity.MAJOR.name());
		ecompErrorInfo.setDescription(new StringBuilder().append("Ecomp error element  not found in YAML, name: ")
				.append(ecompErrorName).toString());
		return ecompErrorInfo;
	}

	private EcompErrorInfo getErrorInfoForDescriptionParamsMismatch(String ecompErrorName) {
		EcompErrorInfo ecompErrorInfo = new EcompErrorInfo();
		ecompErrorInfo.setCode(EcompErrorConfiguration.ECODE_PREFIX + "3002");
		ecompErrorInfo.setType(EcompErrorType.CONFIG_ERROR.name());
		ecompErrorInfo.setSeverity(EcompErrorSeverity.ERROR.name());
		ecompErrorInfo.setAlarmSeverity(EcompAlarmSeverity.MAJOR.name());
		ecompErrorInfo.setDescription(new StringBuilder()
				.append("Ecomp error description params mismatch between code and YAML or wrong format, name: ")
				.append(ecompErrorName).toString());
		return ecompErrorInfo;
	}

	public void processEcompError(String context, EcompErrorEnum ecompErrorEnum, String... descriptionParams) {

		EcompErrorLogUtil.logEcompError(context, ecompErrorEnum, descriptionParams);

	}

}