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
|
/*
* ============LICENSE_START=======================================================
* policy-endpoints
* ================================================================================
* Copyright (C) 2019, 2021 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.policy.common.endpoints.utils;
import lombok.Getter;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.features.NetLoggerFeatureProviders;
import org.onap.policy.common.utils.services.FeatureApiUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A network logging utility class that allows drools applications code to access the
* network log (or other specified loggers) and logging features.
*
*/
public class NetLoggerUtil {
/**
* Loggers.
*/
private static final Logger logger = LoggerFactory.getLogger(NetLoggerUtil.class);
@Getter
private static final Logger networkLogger = LoggerFactory.getLogger("network");
/**
* Constant for the system line separator.
*/
public static final String SYSTEM_LS = System.lineSeparator();
/**
* Specifies if the message is coming in or going out.
*/
public enum EventType {
IN, OUT
}
/**
* Logs a message to the network logger.
*
* @param type can either be IN or OUT
* @param protocol the protocol used to receive/send the message
* @param topic the topic the message came from or null if the type is REST
* @param message message to be logged
*/
public static void log(EventType type, CommInfrastructure protocol, String topic, String message) {
log(networkLogger, type, protocol, topic, message);
}
/**
* Logs a message to the specified logger (i.e. a controller logger).
*
* @param eventLogger the logger that will have the message appended
* @param type can either be IN or OUT
* @param protocol the protocol used to receive/send the message
* @param topic the topic the message came from or null if the type is REST
* @param message message to be logged
*/
public static void log(Logger eventLogger, EventType type, CommInfrastructure protocol, String topic,
String message) {
if (eventLogger == null) {
logger.debug("the logger is null, defaulting to network logger");
eventLogger = networkLogger;
}
if (featureBeforeLog(eventLogger, type, protocol, topic, message)) {
return;
}
eventLogger.info("[{}|{}|{}]{}{}", type, protocol, topic, SYSTEM_LS, message);
featureAfterLog(eventLogger, type, protocol, topic, message);
}
/**
* Executes features that pre-process a message before it is logged.
*
* @param eventLogger the logger that will have the message appended
* @param type can either be IN or OUT
* @param protocol the protocol used to receive/send the message
* @param topic the topic the message came from or null if the type is REST
* @param message message to be logged
*
* @return true if this feature intercepts and takes ownership of the operation
* preventing the invocation of lower priority features. False, otherwise
*/
private static boolean featureBeforeLog(Logger eventLogger, EventType type, CommInfrastructure protocol,
String topic, String message) {
return FeatureApiUtils.apply(NetLoggerFeatureProviders.getProviders().getList(),
feature -> feature.beforeLog(eventLogger, type, protocol, topic, message),
(feature, ex) -> logger.error("feature {} before-log failure because of {}",
feature.getClass().getName(), ex.getMessage(), ex));
}
/**
* Executes features that post-process a message after it is logged.
*
* @param eventLogger the logger that will have the message appended
* @param type can either be IN or OUT
* @param protocol the protocol used to receive/send the message
* @param topic the topic the message came from or null if the type is rest
* @param message message to be logged
*
* @return true if this feature intercepts and takes ownership of the operation
* preventing the invocation of lower priority features. False, otherwise
*/
private static boolean featureAfterLog(Logger eventLogger, EventType type, CommInfrastructure protocol,
String topic, String message) {
return FeatureApiUtils.apply(NetLoggerFeatureProviders.getProviders().getList(),
feature -> feature.afterLog(eventLogger, type, protocol, topic, message),
(feature, ex) -> logger.error("feature {} after-log failure because of {}",
feature.getClass().getName(), ex.getMessage(), ex));
}
}
|
