aboutsummaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/api/LoggerFactory.java
blob: 7029ded38dd2493cb87cbd414e0adfddacf77b09 (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
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * 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.sdc.logging.api;


/**
 * <a>Factory to hide a concrete, framework-specific implementation of logger creation.</a>
 *
 * <p>The service used by this factory must implement {@link LoggerCreationService}. If no implementation has been
 * configured or could not be instantiated, a <b>no-op logger</b> will be used, and <b>no events</b> will be logged.
 * This is done to prevent recursion if attempts are being made to log exceptions that resulted from logger
 * initialization.
 * </p>
 *
 * @author evitaliy
 * @since 13/09/2016.
 *
 * @see BaseFactory
 * @see LoggerCreationService
 */
@SuppressWarnings("ThrowableInstanceNeverThrown")
public class LoggerFactory extends BaseFactory {

    private static final LoggerCreationService SERVICE;

    static {
        LoggerCreationService service;

        try {
            service = locateService(LoggerCreationService.class);
        } catch (Throwable e) {
            new RuntimeException("Failed to instantiate logger factory", e).printStackTrace();
            // use the no-op service to prevent recursion in case of an attempt to log an exception as a
            // result of a logger initialization error
            service = new NoOpLoggerCreationService();
        }

        SERVICE = service;
    }

    public static Logger getLogger(String clazzName) {
        return SERVICE.getLogger(clazzName);
    }

    public static Logger getLogger(Class<?> clazz) {
        return SERVICE.getLogger(clazz);
    }

    private static class NoOpLoggerCreationService implements LoggerCreationService {
        
        private static final Logger NO_OP_LOGGER = new Logger() {
            
            @Override
            public String getName() {
                return "No-Op Logger";
            }

            @Override
            public boolean isMetricsEnabled() {
                return false;
            }

            @Override
            public void metrics(String msg) { }

            @Override
            public void metrics(String msg, Object arg) { }

            @Override
            public void metrics(String msg, Object arg1, Object arg2) { }

            @Override
            public void metrics(String msg, Object... arguments) { }

            @Override
            public void metrics(String msg, Throwable t) { }

            @Override
            public boolean isAuditEnabled() {
                return false;
            }

            @Override
            public void audit(String msg) { }

            @Override
            public void audit(String msg, Object arg) { }

            @Override
            public void audit(String msg, Object arg1, Object arg2) { }

            @Override
            public void audit(String msg, Object... arguments) { }

            @Override
            public void audit(String msg, Throwable t) { }

            @Override
            public boolean isDebugEnabled() {
                return false;
            }

            @Override
            public void debug(String msg) { }

            @Override
            public void debug(String msg, Object arg) { }

            @Override
            public void debug(String msg, Object arg1, Object arg2) { }

            @Override
            public void debug(String msg, Object... arguments) { }

            @Override
            public void debug(String msg, Throwable t) { }

            @Override
            public boolean isInfoEnabled() {
                return false;
            }

            @Override
            public void info(String msg) { }

            @Override
            public void info(String msg, Object arg) { }

            @Override
            public void info(String msg, Object arg1, Object arg2) { }

            @Override
            public void info(String msg, Object... arguments) { }

            @Override
            public void info(String msg, Throwable t) { }

            @Override
            public boolean isWarnEnabled() {
                return false;
            }

            @Override
            public void warn(String msg) { }

            @Override
            public void warn(String msg, Object arg) { }

            @Override
            public void warn(String msg, Object... arguments) { }

            @Override
            public void warn(String msg, Object arg1, Object arg2) { }

            @Override
            public void warn(String msg, Throwable t) { }

            @Override
            public boolean isErrorEnabled() {
                return false;
            }

            @Override
            public void error(String msg) { }

            @Override
            public void error(String msg, Object arg) { }

            @Override
            public void error(String msg, Object arg1, Object arg2) { }

            @Override
            public void error(String msg, Object... arguments) { }

            @Override
            public void error(String msg, Throwable t) { }
        };
        
        @Override
        public Logger getLogger(String className) {
            return NO_OP_LOGGER;
        }

        @Override
        public Logger getLogger(Class<?> clazz) {
            return NO_OP_LOGGER;
        }
    }
}