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
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* Copyright © 2017-2018 Amdocs
* ================================================================================
* 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.aai.cl.api;
import org.onap.aai.cl.mdc.MdcOverride;
/** Defines the common API which all Logger implementations must expose. */
public interface Logger {
/**
* Indicate whether or not TRACE level logging is enabled.
*
* @return true if TRACE level logs are enabled, false otherwise
*/
public boolean isTraceEnabled();
/**
* Indicate whether or not INFO level logging is enabled.
*
* @return true if INFO level logs are enabled, false otherwise
*/
public boolean isInfoEnabled();
/**
* Indicate whether or not ERROR level logging is enabled.
*
* @return true if ERROR level logs are enabled, false otherwise
*/
public boolean isErrorEnabled();
/**
* Indicate whether or not WARNING level logging is enabled.
*
* @return true if WARNING level logs are enabled, false otherwise
*/
public boolean isWarnEnabled();
/**
* Indicate whether or not DEBUG level logging is enabled.
*
* @return true if DEBUG level logs are enabled, false otherwise
*/
public boolean isDebugEnabled();
/**
* Log an INFO message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode
* - Log message identifier.
* @param arguments
* - Arguments to populate the log message template with.
*/
public void info(Enum logCode, String... arguments);
/**
* Log an INFO message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode
* - Log message identifier.
* @param fields
* - Map containing values for any log fields which the client wants
* to populate.
* @param arguments
* - Arguments to populate the log message template with.
*/
public void info(Enum logCode, LogFields fields, String... arguments);
/**
* Log an INFO message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param fields - Map containing values for any log fields which the
* client wants to populate.
* @param override - A set of values to override values stored in the MDC context
* @param arguments - Arguments to populate the log message template with.
*/
public void info(Enum logCode, LogFields fields, MdcOverride override, String... arguments);
/**
* Log a WARNING message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param arguments - Arguments to populate the log message template with.
*/
public void warn(Enum logCode, String... arguments);
/**
* Log a WARNING message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param fields - Map containing values for any log fields which the
* client wants to populate.
* @param arguments - Arguments to populate the log message template with.
*/
public void warn(Enum logCode, LogFields fields, String... arguments);
/**
* Log a TRACE message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param arguments - Arguments to populate the log message template with.
*/
public void trace(Enum logCode, String... arguments);
/**
* Log a TRACE message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param fields - Map containing values for any log fields which the
* client wants to populate.
* @param arguments - Arguments to populate the log message template with.
*/
public void trace(Enum logCode, LogFields fields, String... arguments);
/**
* Log a simple, non-templated DEBUG message.
*
* @param logMessage - The message to be logged.
*/
public void debug(String logMessage);
/**
* Log a DEBUG message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param arguments - Arguments to populate the log message template with.
*/
public void debug(Enum logCode, String... arguments);
/**
* Log a DEBUG message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param fields - Map containing values for any log fields which the
* client wants to populate.
* @param arguments - Arguments to populate the log message template with.
*/
public void debug(Enum logCode, LogFields fields, String... arguments);
/**
* Log an ERROR message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param arguments - Arguments to populate the log message template with.
*/
public void error(Enum logCode, String... arguments);
/**
* Log an ERROR message based on a message key defined in a resource bundle
* with arguments.
*
* @param logCode - Log message identifier.
* @param fields - Map containing values for any log fields which the
* client wants to populate.
* @param arguments - Arguments to populate the log message template with.
*/
public void error(Enum logCode, LogFields fields, String... arguments);
/**
* Log an ERROR message based on a message key defined in a resource bundle
* with arguments and a throwable exception.
*
* @param logCode - Log message identifier.
* @param ex - The exception to be logged.
* @param arguments - Arguments to populate the log message template with.
*/
public void error(Enum logCode, Throwable ex, String... arguments);
/**
* Log an ERROR message based on a message key defined in a resource bundle
* with arguments and a throwable exception.
*
* @param logCode - Log message identifier.
* @param fields - Map containing values for any log fields which the
* client wants to populate.
* @param ex - The exception to be logged.
* @param arguments - Arguments to populate the log message template with.
*/
public void error(Enum logCode, LogFields fields, Throwable ex, String... arguments);
/**
* Format the given log using the supplied arguments
* @param logCode - Log message identifier.
* @param arguments - Arguments to populate the log message template with.
*/
public String formatMsg(Enum logCode, String... arguments);
}
|
