src/main/java/org/onap/aai/champ/ChampAPI.java

   1 /**
   2  * ============LICENSE_START==========================================
   3  * org.onap.aai
   4  * ===================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22 package org.onap.aai.champ;
  23
  24 import org.onap.aai.champ.graph.impl.ChampAPIImpl;
  25
  26 public interface ChampAPI {
  27
  28         /**
  29          * A factory for constructing basic ChampAPI implementations (minimal).
  30          * If finer control is needed, you should consider accessing an implementation's
  31          * constructors/builders.
  32          */
  33         public static final class Factory {
  34                 private Factory() { throw new RuntimeException("Cannot instantiate ChampAPI.Factory"); }
  35
  36                 public static ChampAPI newInstance(ChampGraph.Type type) {
  37                         return new ChampAPIImpl(type);
  38                 }
  39         }
  40
  41         public ChampGraph getGraph(String graphName);
  42
  43         public ChampGraph.Type getType();
  44
  45         /**
  46          * Shutdown the ChampAPI. It is up to the caller to synchronize access to the ChampAPI
  47          * so that shutting it down does not interfere with concurrent operations.
  48          */
  49         public void shutdown();
  50 }
  51