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
|
/*
* ================================================================================
* Copyright (c) 2018 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.dcae.utils.eelf.logger.api.log;
import org.onap.dcae.utils.eelf.logger.api.info.LogLevelCategory;
import org.onap.dcae.utils.eelf.logger.api.spec.AuditLogSpec;
import org.onap.dcae.utils.eelf.logger.api.spec.OptionalLogSpec;
/**
* Audit Log captures all log levels supported by audit specifications
*
* @author Rajiv Singla
*/
public interface AuditLog {
/**
* Logs audit message with provided {@link LogLevelCategory}
*
* @param logLevelCategory log level category
* @param message log message
* @param auditLogSpec audit log spec
* @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void log(LogLevelCategory logLevelCategory, String message, AuditLogSpec auditLogSpec,
OptionalLogSpec optionalLogSpec, String... args);
/**
* Logs audit message with provided {@link LogLevelCategory} and with default {@link OptionalLogSpec}
*
* @param logLevelCategory log level category
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void log(LogLevelCategory logLevelCategory, String message, AuditLogSpec auditLogSpec, String... args);
/**
* Logs audit message with provided INFO {@link LogLevelCategory}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void info(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
/**
* Logs audit message with provided INFO {@link LogLevelCategory} and with default {@link OptionalLogSpec}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void info(String message, AuditLogSpec auditLogSpec, String... args);
/**
* Logs audit message with provided WARN {@link LogLevelCategory}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void warn(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
/**
* Logs audit message with provided WARN {@link LogLevelCategory} and with default {@link OptionalLogSpec}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void warn(String message, AuditLogSpec auditLogSpec, String... args);
/**
* Logs audit message with provided ERROR {@link LogLevelCategory}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void error(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
/**
* Logs audit message with provided ERROR {@link LogLevelCategory} and with default {@link OptionalLogSpec}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void error(String message, AuditLogSpec auditLogSpec, String... args);
/**
* Logs audit message with provided FATAL {@link LogLevelCategory}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void fatal(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
/**
* Logs audit message with provided FATAL {@link LogLevelCategory} and with default {@link OptionalLogSpec}
*
* @param message log message
* @param auditLogSpec audit log spec
* @param args argument values for log message interpolation
*/
void fatal(String message, AuditLogSpec auditLogSpec, String... args);
}
|
