champ-lib/champ-core/src/main/java/org/onap/aai/champcore/ChampAPI.java

   1 /**
   2  * ============LICENSE_START==========================================
   3  * org.onap.aai
   4  * ===================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 Amdocs
   7  * ===================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END============================================
  20  */
  21 package org.onap.aai.champcore;
  22
  23 import org.onap.aai.champcore.graph.impl.ChampAPIImpl;
  24
  25 public interface ChampAPI {
  26
  27         /**
  28          * A factory for constructing basic ChampAPI implementations (minimal).
  29          * If finer control is needed, you should consider accessing an implementation's
  30          * constructors/builders.
  31          */
  32         public static final class Factory {
  33                 private Factory() { throw new RuntimeException("Cannot instantiate ChampAPI.Factory"); }
  34
  35                 public static ChampAPI newInstance(String type) {
  36                         return new ChampAPIImpl(type);
  37                 }
  38         }
  39
  40         public ChampGraph getGraph(String graphName);
  41
  42         public String getType();
  43
  44         /**
  45          * Shutdown the ChampAPI. It is up to the caller to synchronize access to the ChampAPI
  46          * so that shutting it down does not interfere with concurrent operations.
  47          */
  48         public void shutdown();
  49 }
  50