aboutsummaryrefslogtreecommitdiffstats
path: root/common-logging/src/main/java/org/openecomp/policy/common/logging/flexlogger/Logger.java
blob: ae2100814bab02f623778faa04a5e865d0932f00 (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
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
/*-
 * ============LICENSE_START=======================================================
 * ECOMP-Logging
 * ================================================================================
 * 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.policy.common.logging.flexlogger;

import static org.openecomp.policy.common.logging.eelf.Configuration.STATUS_CODE;

import static com.att.eelf.configuration.Configuration.MDC_SERVICE_NAME;
import java.util.UUID;

import org.slf4j.MDC;

import org.openecomp.policy.common.logging.eelf.MessageCodes;

/**
 * 
 * Interface Logger - implemented by Logger4J, EelfLogger and SystemOutLogger
 *
 */
public interface Logger {	
	
	/**
	 * Prints messages with the level.DEBUG
	 */
	public void debug(Object message);
	
	/**
	 * Prints messages with the level.ERROR
	 */
	public void error(Object message);
	
	/**
	 * Prints messages with the level.ERROR
	 */
	public void error(MessageCodes msg, Throwable arg0, String... arguments);

	/**
	 * Prints messages with the level.INFO
	 */
	public void info(Object message);
	
	/**
	 * Prints messages with the level.WARN
	 */
	public void warn(Object message);		

	/**
	 * Prints messages with the level.TRACE
	 */
	public void trace(Object message);	
	
	/**
	 * Prints messages in audit log with the level.INFO
	 */
	public void audit(Object arg0);
	
	/**
	 * Prints messages with the level.DEBUG
	 */
	public void debug(Object message, Throwable t);
	
	/**
	 * Prints messages with the level.ERROR
	 */
	public void error(Object message, Throwable t);

	/**
	 * Prints messages with the level.INFO
	 */
	public void info(Object message, Throwable t);
	
	/**
	 * Prints messages with the level.WARN
	 */
	public void warn(Object message, Throwable t);		

	/**
	 * Prints messages with the level.TRACE
	 */
	public void trace(Object message, Throwable t);	
	
	/**
	 * Prints messages in audit log with the level.INFO
	 */
	public void audit(Object arg0, Throwable t);
	
	/**
	 * Records event Id in audit log with the level.INFO
	 */
	public void recordAuditEventStart(String eventId);
	
	/**
	 * Records the starting time of the event with its request Id as the key
	 */
	public void recordAuditEventStart(UUID eventId);
	
	/**
	 * Records the ending time of the event with its request Id as the key
	 */
	public void recordAuditEventEnd(String eventId, String rule, String policyVersion );
	
	/**
	 * Records the ending time of the event with its request Id as the key
	 */
	public void recordAuditEventEnd(UUID eventId, String rule, String policyVersion);
	
	/**
	 * Records the ending time of the event with its request Id as the key
	 */
	public void recordAuditEventEnd(String eventId, String rule);
	
	/**
	 * Records the ending time of the event with its request Id as the key
	 */
	public void recordAuditEventEnd(UUID eventId, String rule);
	
	
	/**
	 * Records the Metrics with event Id and log message 
	 */
	public void recordMetricEvent(String eventId, String arg1);
	
	/**
	 * Records the Metrics with event Id and log message 
	 */
	public void recordMetricEvent(UUID eventId, String arg1);
	
	/**
	 * Records the Metrics log message
	 */
	public void metrics(Object arg0);
	
	/**
	 * Returns a boolean value, true for debug logging enabled, false for not enabled
	 */
	public boolean isDebugEnabled();
	
	/**
	 * Returns a boolean value, true for error logging enabled, false for not enabled
	 */
	public boolean isErrorEnabled();
	
	/**
	 * Returns a boolean value, true for warn logging enabled, false for not enabled
	 */
	public boolean isWarnEnabled();
	
	/**
	 * Returns a boolean value, true for info logging enabled, false for not enabled
	 */
	public boolean isInfoEnabled();	

	/**
	 * Returns a boolean value, true for error logging enabled, false for not enabled
	 */
	public boolean isAuditEnabled();
	
	/**
	 * Returns a boolean value, true for warn logging enabled, false for not enabled
	 */
	public boolean isMetricsEnabled();
	
	/**
	 * Returns a boolean value, true for trace logging enabled, false for not enabled
	 */
	public boolean isTraceEnabled();
	
	
	/**
	 * Populates MDC info
	 */	
	public String postMDCInfoForEvent(String transId);
	
	/**
	 * Prints messages with the level.WARN
	 */
	public void warn(MessageCodes msg, String... arguments) ;
	
	/**
	 * Prints messages with the level.WARN
	 */
	public void warn(MessageCodes msg, Throwable arg0, String... arguments) ;
	
	/**
	 * Prints messages with the level.ERROR
	 */
	public void error(MessageCodes msg, String... arguments) ;
	
	/**
	 * Sets transaction Id
	 */
	public void setTransId(String transId);

	/**
	 * Returns transaction Id
	 */
	String getTransId();
	
	/**
	 * Populates MDC Info for the rule triggered
	 */
	public void postMDCInfoForTriggeredRule(String transId);
	
	/**
	 * Populates MDC Info
	 */
	public void postMDCInfoForEvent(Object o);
	
}