forked from ESAPI/esapi-java-legacy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLogger.java
More file actions
230 lines (208 loc) · 5.73 KB
/
Copy pathLogger.java
File metadata and controls
230 lines (208 loc) · 5.73 KB
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
/**
* OWASP Enterprise Security API (ESAPI)
*
* This file is part of the Open Web Application Security Project (OWASP)
* Enterprise Security API (ESAPI) project. For details, please see
* <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a>.
*
* Copyright (c) 2007 - The OWASP Foundation
*
* The ESAPI is published by OWASP under the BSD license. You should read and accept the
* LICENSE before you use, modify, and/or redistribute this software.
*
* @author Jeff Williams <a href="http://www.aspectsecurity.com">Aspect Security</a>
* @created 2007
*/
package org.owasp.esapi;
/**
* The Logger interface defines a set of methods that can be used to log
* security events. Implementors should use a well established logging library
* as it is quite difficult to create a high-performance logger.
* <P>
* <img src="doc-files/Logger.jpg" height="600">
* <P>
*
* The order of logging levels is:
* <ul>
* <li>trace</li>
* <li>debug</li>
* <li>info</li>
* <li>warn</li>
* <li>error</li>
* <li>fatal (the most serious)</li>
* </ul>
*
* In the default implementation, this interface is implemented by JavaLogger.class, which is an inner class in JavaLogFactory.java
*
* @author Jeff Williams (jeff.williams .at. aspectsecurity.com) <a
* href="http://www.aspectsecurity.com">Aspect Security</a>
* @since June 1, 2007
*/
public interface Logger {
String SECURITY = "SECURITY";
String USABILITY = "USABILITY";
String PERFORMANCE = "PERFORMANCE";
String FUNCTIONALITY = "FUNCTIONALITY";
/**
* Log critical.
*
* @param type
* the type of event
* @param message
* the message to log to log
*/
void fatal(String type, String message);
/**
* Log critical.
*
* @param type
* the type of event of event
* @param message
* the message to log to log
* @param throwable
* the exception thrown
*/
void fatal(String type, String message, Throwable throwable);
/**
* Allows the caller to determine if messages logged at this level
* will be discarded, to avoid performing expensive processing
*
* @return true if fatal messages will be output to the log
*/
boolean isFatalEnabled();
/**
* Log debug.
*
* @param type
* the type of event
* @param message
* the message to log
*/
void debug(String type, String message);
/**
* Log debug.
*
* @param type
* the type of event
* @param message
* the message to log
* @param throwable
* the exception thrown
*/
void debug(String type, String message, Throwable throwable);
/**
* Allows the caller to determine if messages logged at this level
* will be discarded, to avoid performing expensive processing
*
* @return true if debug messages will be output to the log
*/
boolean isDebugEnabled();
/**
* Log error.
*
* @param type
* the type of event
* @param message
* the message to log
*/
void error(String type, String message);
/**
* Log error.
*
* @param type
* the type of event
* @param message
* the message to log
* @param throwable
* the exception thrown
*/
void error(String type, String message, Throwable throwable);
/**
* Allows the caller to determine if messages logged at this level
* will be discarded, to avoid performing expensive processing
*
* @return true if error messages will be output to the log
*/
boolean isErrorEnabled();
/**
* Log success.
*
* @param type
* the type of event
* @param message
* the message to log
*/
void info(String type, String message);
/**
* Log success.
*
* @param type
* the type of event
* @param message
* the message to log
* @param throwable
* the exception thrown
*/
void info(String type, String message, Throwable throwable);
/**
* Allows the caller to determine if messages logged at this level
* will be discarded, to avoid performing expensive processing
*
* @return true info if messages will be output to the log
*/
boolean isInfoEnabled();
/**
* Log trace.
*
* @param type
* the type of event
* @param message
* the message to log
*/
void trace(String type, String message);
/**
* Log trace.
*
* @param type
* the type of event
* @param message
* the message to log
* @param throwable
* the exception thrown
*/
void trace(String type, String message, Throwable throwable);
/**
* Allows the caller to determine if messages logged at this level
* will be discarded, to avoid performing expensive processing
*
* @return true if trace messages will be output to the log
*/
boolean isTraceEnabled();
/**
* Log warning.
*
* @param type
* the type of event
* @param message
* the message to log
*/
void warning(String type, String message);
/**
* Log warning.
*
* @param type
* the type of event
* @param message
* the message to log
* @param throwable
* the exception thrown
*/
void warning(String type, String message, Throwable throwable);
/**
* Allows the caller to determine if messages logged at this level
* will be discarded, to avoid performing expensive processing
*
* @return true if warning messages will be output to the log
*/
boolean isWarningEnabled();
}