[SDC-29] Amdocs OnBoard 1707 initial commit.
[sdc.git] / common / openecomp-logging-lib / openecomp-logging-api / src / main / java / org / openecomp / core / logging / api / BaseFactory.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * SDC
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  * 
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  * 
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.openecomp.core.logging.api;
22
23 import java.util.Iterator;
24 import java.util.ServiceLoader;
25
26 /**
27  * Contains common functionality for factories used in the logging framework. <p>In order to use the
28  * factory, a particular (e.g. framework-specific) implementation of a service must be configured as
29  * described in <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html">java.util.ServiceLoader</a>).</p>
30  *
31  * @see java.util.ServiceLoader
32  */
33 public class BaseFactory {
34
35   protected static <T> T locateService(Class<T> clazz) throws Exception {
36
37     T service;
38     ServiceLoader<T> loader = ServiceLoader.load(clazz);
39     Iterator<T> iterator = loader.iterator();
40     if (iterator.hasNext()) {
41
42       service = iterator.next();
43       if (iterator.hasNext()) {
44         System.err.println(String.format("Warning! Configured more than one implementation of %s",
45             clazz.getName()));
46       }
47
48       return service;
49     }
50
51     throw new IllegalArgumentException(
52         (String.format("No implementations configured for %s", clazz.getName())));
53   }
54 }