summaryrefslogtreecommitdiffstats
path: root/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/DebugLog.java
blob: 98a0921441e30f835252e38237d8a6d76d0f4dc9 (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
/*
 * ================================================================================
 * 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.DebugLogSpec;
import org.onap.dcae.utils.eelf.logger.api.spec.OptionalLogSpec;

/**
 * Debug Log captures all log levels supported by debug specifications.
 * <p>
 * <b>NOTE: DEBUG Log is optional as per EELF Specifications</b>
 *
 * @author Rajiv Singla
 */
public interface DebugLog {

    /**
     * Logs debug message with provided {@link LogLevelCategory}
     *
     * @param logLevelCategory log level category
     * @param message log message
     * @param debugLogSpec debug log spec
     * @param optionalLogSpec optional log spec
     * @param args argument values for log message interpolation
     */
    void log(LogLevelCategory logLevelCategory, String message, DebugLogSpec debugLogSpec,
             OptionalLogSpec optionalLogSpec, String... args);

    /**
     * Logs debug message with provided {@link LogLevelCategory} and with default {@link OptionalLogSpec}
     *
     * @param logLevelCategory log level category
     * @param message log message
     * @param debugLogSpec debug log spec
     * @param args argument values for log message interpolation
     */
    void log(LogLevelCategory logLevelCategory, String message, DebugLogSpec debugLogSpec, String... args);


    /**
     * Logs debug message with provided DEBUG {@link LogLevelCategory}
     *
     * @param message log message
     * @param debugLogSpec debug log spec
     * @param args argument values for log message interpolation
     */
    void debug(String message, DebugLogSpec debugLogSpec, OptionalLogSpec optionalLogSpec, String... args);

    /**
     * Logs debug message with provided DEBUG {@link LogLevelCategory} and with default {@link OptionalLogSpec}
     *
     * @param message log message
     * @param debugLogSpec debug log spec
     * @param args argument values for log message interpolation
     */
    void debug(String message, DebugLogSpec debugLogSpec, String... args);

}