gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2017 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.openecomp.sdc.logging.api;
  18
  19 import java.util.Iterator;
  20 import java.util.Optional;
  21 import java.util.ServiceLoader;
  22 import org.openecomp.sdc.logging.spi.LoggerCreationService;
  23 import org.openecomp.sdc.logging.spi.LoggingContextService;
  24 import org.openecomp.sdc.logging.spi.LoggingServiceProvider;
  25
  26 /**
  27  * <p>Binds to a concrete implementation of logging services.</p>
  28  * <p>In order to use the factory, a particular (e.g. framework-specific) implementation of a service must be
  29  * configured as described in
  30  * <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html">java.util.ServiceLoader</a>).</p>
  31  *
  32  * @author evitaliy
  33  * @see ServiceLoader
  34  * @since 13 Sep 2016
  35  */
  36
  37 // No advanced logging can be used here because we don't know
  38 // which underlying implementation will be used
  39 @SuppressWarnings({"UseOfSystemOutOrSystemErr", "squid:S106", "squid:S1166"})
  40 class ServiceBinder {
  41
  42     private static final LoggingServiceProvider PROVIDER = lookupProvider();
  43
  44     private ServiceBinder() {
  45         // prevent instantiation
  46     }
  47
  48     private static LoggingServiceProvider lookupProvider() {
  49
  50         ServiceLoader<LoggingServiceProvider> loader = ServiceLoader.load(LoggingServiceProvider.class);
  51         Iterator<LoggingServiceProvider> iterator = loader.iterator();
  52
  53         if (!iterator.hasNext()) {
  54             System.err.printf("[ERROR] No provider configured for logging services %s. "
  55                     + "Default implementation will be used.\n", LoggingServiceProvider.class.getName());
  56             return null;
  57         }
  58
  59         try {
  60
  61             LoggingServiceProvider provider = iterator.next();
  62             if (!iterator.hasNext()) {
  63                 return provider;
  64             }
  65
  66             Logger logger = provider.getLogger(ServiceBinder.class);
  67             if (logger.isWarnEnabled()) {
  68                 logger.warn("More than one provider for logging services {} found",
  69                         LoggingServiceProvider.class.getName());
  70             }
  71
  72             return provider;
  73
  74         } catch (Exception e) {
  75             // don't fail if the provider cannot be instantiated
  76             e.printStackTrace(System.err);
  77             return null;
  78         }
  79     }
  80
  81     static Optional<LoggingContextService> getContextServiceBinding() {
  82         return Optional.ofNullable(PROVIDER);
  83     }
  84
  85     static Optional<LoggerCreationService> getCreationServiceBinding() {
  86         return Optional.ofNullable(PROVIDER);
  87     }
  88 }
  89