aboutsummaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/api/ServiceBinder.java
blob: 5aaa301a9ca8b743180e288ec52eabe80b72d1a2 (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
/*
 * Copyright © 2016-2017 European Support Limited
 *
 * 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.
 */

package org.openecomp.sdc.logging.api;

import org.openecomp.sdc.logging.spi.LoggerCreationService;
import org.openecomp.sdc.logging.spi.LoggingContextService;
import org.openecomp.sdc.logging.spi.LoggingServiceProvider;

import java.util.Iterator;
import java.util.Optional;
import java.util.ServiceLoader;

/**
 * <p>Binds to a concrete implementation of logging services.</p>
 * <p>In order to use the factory, a particular (e.g. framework-specific) implementation of a service must be
 * configured as described in
 * <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html">java.util.ServiceLoader</a>).</p>
 *
 * @author evitaliy
 * @see ServiceLoader
 * @since 13 Sep 2016
 */

// No advanced logging can be used here because we don't know
// which underlying implementation will be used
@SuppressWarnings({"UseOfSystemOutOrSystemErr", "squid:S106"})
class ServiceBinder {

    private static final LoggingServiceProvider PROVIDER = lookupProvider();

    private ServiceBinder() {
        // prevent instantiation
    }

    private static LoggingServiceProvider lookupProvider() {

        ServiceLoader<LoggingServiceProvider> loader = ServiceLoader.load(LoggingServiceProvider.class);
        Iterator<LoggingServiceProvider> iterator = loader.iterator();

        if (!iterator.hasNext()) {
            System.err.printf("[ERROR] No provider configured for logging services %s. "
                    + "Default implementation will be used.\n", LoggingServiceProvider.class.getName());
            return null;
        }

        try {

            LoggingServiceProvider provider = iterator.next();
            if (!iterator.hasNext()) {
                return provider;
            }

            Logger logger = provider.getLogger(ServiceBinder.class);
            if (logger.isWarnEnabled()) {
                logger.warn("More than one provider for logging services {} found",
                        LoggingServiceProvider.class.getName());
            }

            return provider;

        } catch (Exception e) {
            // don't fail if the provider cannot be instantiated
            e.printStackTrace(System.err);
            return null;
        }
    }

    static Optional<LoggingContextService> getContextServiceBinding() {
        return Optional.ofNullable(PROVIDER);
    }

    static Optional<LoggerCreationService> getCreationServiceBinding() {
        return Optional.ofNullable(PROVIDER);
    }
}