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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
/*-
* ================================================================================
* ECOMP Portal
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property
* ================================================================================
* 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.
* ================================================================================
*/
package org.openecomp.portalapp.portal.utils;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import javax.servlet.http.HttpServletResponse;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.openecomp.portalapp.portal.domain.EPUser;
import org.openecomp.portalapp.portal.logging.format.EPAppMessagesEnum;
import org.openecomp.portalapp.portal.logging.logic.EPLogUtil;
import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.openecomp.portalsdk.core.util.SystemProperties;
import org.slf4j.MDC;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
public class EcompPortalUtils {
private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(EcompPortalUtils.class);
/**
* @param orgUserId
* @return true if orgUserId is not empty and contains only alphanumeric,
* false otherwise
*/
public static boolean legitimateUserId(String orgUserId) {
return orgUserId.matches("^[a-zA-Z0-9]+$");
}
/**
* Splits the string into a list of tokens using the specified regular
* expression
*
* @param source
* @param regex
* @return List of tokens split from the source
*/
public static List<String> parsingByRegularExpression(String source, String regex) {
List<String> tokens = new ArrayList<String>();
if (source != null && source.length() > 0) {
String[] parsed = source.split(regex);
for (String token : parsed) {
if (token.length() > 0) {
tokens.add(token);
}
}
}
return tokens;
}
/**
* Builds a JSON object with error code and message information.
*
* @param errorCode
* @param errorMessage
* @return JSON object as a String
*/
public static String jsonErrorMessageResponse(int errorCode, String errorMessage) {
return "{\"error\":{\"code\":" + errorCode + "," + "\"message\":\"" + errorMessage + "\"}}";
}
/**
* Builds a JSON object with the specified message
*
* @param message
* @return JSON object as a String
*/
public static String jsonMessageResponse(String message) {
return String.format("{\"message\":\"%s\"}", message);
}
/**
* Serializes the specified object as JSON and writes the result to the
* debug log. If serialization fails, logs a message to the error logger.
*
* @param logger
* Logger for the class where the object was built; the logger
* carries the class name.
* @param source
* First portion of the log message
* @param msg
* Second portion of the log message
* @param obj
* Object to serialize as JSON
*/
public static void logAndSerializeObject(EELFLoggerDelegate logger, String source, String msg, Object obj) {
try {
String objectAsJson = new ObjectMapper().writeValueAsString(obj);
logger.debug(EELFLoggerDelegate.debugLogger,
String.format("source= [%s]; %s [%s];", source, msg, objectAsJson));
} catch (JsonProcessingException e) {
logger.warn(EELFLoggerDelegate.errorLogger, "logAndSerializedObject failed to serialize", e);
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeInvalidJsonInput, e);
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "logAndSerializedObject failed", e);
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeInvalidJsonInput, e);
}
}
/**
* Serializes the specified object as JSON and writes the result to the
* debug log. If serialization fails, logs a message to the error logger.
*
* @param source
* First portion of the log message
* @param msg
* Second portion of the log message
* @param obj
* Object to serialize as JSON
*/
public static void logAndSerializeObject(String source, String msg, Object obj) {
logAndSerializeObject(logger, source, msg, obj);
}
public static void rollbackTransaction(Transaction transaction, String errorMessage) {
logger.error(EELFLoggerDelegate.errorLogger, errorMessage);
try {
if (transaction != null) {
transaction.rollback();
}
} catch (Exception e) {
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeExecuteRollbackError, e);
logger.error(EELFLoggerDelegate.errorLogger, "Exception occurred while performing a rollback transaction",
e);
}
}
public static void closeLocalSession(Session localSession, String errorMessage) {
logger.error(EELFLoggerDelegate.errorLogger, errorMessage);
try {
if (localSession != null) {
localSession.close();
}
} catch (Exception e) {
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeDaoCloseSessionError, e);
logger.error(EELFLoggerDelegate.errorLogger, errorMessage + ", closeLocalSession exception", e);
}
}
// TODO: GLOBAL_LOGIN_URL is the same as in SessionTimeoutInterceptor.
// It should be defined in SystemProperties.
private static final String GLOBAL_LOGIN_URL = "global-login-url";
/**
* Set response status to Unauthorized if user == null and to Forbidden in
* all (!) other cases. Logging is not performed if invocator == null
*
* @param user
* @param response
* @param invocator
* - may be null
*/
public static void setBadPermissions(EPUser user, HttpServletResponse response, String invocator) {
if (user == null) {
String loginUrl = SystemProperties.getProperty(EPCommonSystemProperties.LOGIN_URL_NO_RET_VAL);
response.setHeader(GLOBAL_LOGIN_URL, loginUrl);
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
MDC.put(EPCommonSystemProperties.RESPONSE_CODE, Integer.toString(HttpServletResponse.SC_UNAUTHORIZED));
} else {
response.setStatus(HttpServletResponse.SC_FORBIDDEN);
MDC.put(EPCommonSystemProperties.RESPONSE_CODE, Integer.toString(HttpServletResponse.SC_FORBIDDEN));
}
if (invocator != null) {
logger.warn(EELFLoggerDelegate.errorLogger,
invocator + ", permissions problem, response status = " + response.getStatus());
}
}
public static int getExternalAppResponseCode() {
String responseCode = MDC.get(EPCommonSystemProperties.EXTERNAL_API_RESPONSE_CODE);
int responseCodeInt = 0;
try {
if (responseCode != null && responseCode != "") {
responseCodeInt = Integer.valueOf(responseCode);
}
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger,
"Exception occurred in getResponseCode(). Details: " + EcompPortalUtils.getStackTrace(e));
}
return responseCodeInt;
}
// This method might be just for testing purposes.
public static void setExternalAppResponseCode(int responseCode) {
try {
String responseCodeString = String.valueOf(responseCode);
MDC.put(EPCommonSystemProperties.EXTERNAL_API_RESPONSE_CODE, responseCodeString);
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger,
"Exception occurred in setResponseCode(). Details: " + EcompPortalUtils.getStackTrace(e));
}
}
public static String getHTTPStatusString(int httpStatusCode) {
String httpStatusString = "unknown_error";
try {
httpStatusString = org.springframework.http.HttpStatus.valueOf(httpStatusCode).name();
if (httpStatusString != null) {
httpStatusString = httpStatusString.toLowerCase();
}
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger,
"Exception occurred in getHTTPStatusString(). Details: " + EcompPortalUtils.getStackTrace(e));
}
return httpStatusString;
}
public static String getFEErrorString(Boolean internal, int responseCode) {
// Return a String like the following:
// "Internal Ecomp Error: 500 internal_server_error" or
// "External App Error: 404 not_found"
// TODO: create our own Ecomp error codes, starting with 1000 and up.
String responseString = "";
String internalExternalString = internal ? "Ecomp Error: " : "App Error: ";
String httpStatusString = "unknown_error";
try {
if (responseCode < 1000) {
httpStatusString = getHTTPStatusString(responseCode);
}
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger,
"Exception occurred in getFEErrorString(). Details: " + EcompPortalUtils.getStackTrace(e));
}
responseString = internalExternalString + responseCode + " " + httpStatusString;
return responseString;
}
public static boolean isProductionBuild() {
boolean productionBuild = true;
String epVersion = EcompVersion.buildNumber;
if (epVersion != null) {
int buildNum = epVersion.lastIndexOf('.');
if (buildNum > 0) {
int buildNumber = Integer.parseInt(epVersion.substring(buildNum + 1));
if (buildNumber < 3000) // Production versions are 3000+, (ie
// 1.0.3003)
{
productionBuild = false;
}
}
}
return productionBuild;
}
private static final Object stackTraceLock = new Object();
public static String getStackTrace(Throwable t) {
synchronized (stackTraceLock) {
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
t.printStackTrace(pw);
return sw.toString();
}
}
public static String getMyIpAdddress() {
InetAddress ip;
String localIp;
try {
ip = InetAddress.getLocalHost();
localIp = ip.getHostAddress();
} catch (UnknownHostException e) {
localIp = "unknown";
logger.error(EELFLoggerDelegate.errorLogger, EcompPortalUtils.getStackTrace(e));
}
return localIp;
}
public static String getMyHostName() {
InetAddress ip;
String hostName;
try {
ip = InetAddress.getLocalHost();
hostName = ip.getHostName();
} catch (UnknownHostException e) {
hostName = "unknown";
logger.error(EELFLoggerDelegate.errorLogger, EcompPortalUtils.getStackTrace(e));
}
return hostName;
}
/* return a default property if the expected one is not available */
public static String getPropertyOrDefault(String property, String defaultValue) {
return ((null == SystemProperties.getProperty(property) || SystemProperties.getProperty(property).equals(""))
? defaultValue : SystemProperties.getProperty(property));
}
/**
* Calculates the time duration of a function call for logging purpose. It
* stores the result by using "MDC.put(SystemProperties.MDC_TIMER,
* timeDifference);" It is important to call
* "MDC.remove(SystemProperties.MDC_TIMER);" after this method call to clean
* up the record in MDC
*
* @param beginDateTime
* the given begin time for the call
* @param endDateTime
* the given end time for the call
*
*/
public static void calculateDateTimeDifferenceForLog(String beginDateTime, String endDateTime) {
if (beginDateTime != null && endDateTime != null) {
try {
SimpleDateFormat ecompLogDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
Date beginDate = ecompLogDateFormat.parse(beginDateTime);
Date endDate = ecompLogDateFormat.parse(endDateTime);
String timeDifference = String.format("%d", endDate.getTime() - beginDate.getTime());
MDC.put(SystemProperties.MDC_TIMER, timeDifference);
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, EcompPortalUtils.getStackTrace(e));
}
}
}
}
|