sparkybe-onap-service/src/main/java/org/onap/aai/sparky/sync/IndexSynchronizer.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.sparky.sync;
  22
  23 import org.onap.aai.sparky.sync.enumeration.OperationState;
  24 import org.onap.aai.sparky.sync.enumeration.SynchronizerState;
  25
  26 /**
  27  * The Interface IndexSynchronizer.
  28  *
  29  * @author davea.
  30  */
  31 public interface IndexSynchronizer {
  32
  33   /**
  34    * Do sync.
  35    *
  36    * @return the operation state
  37    */
  38   public OperationState doSync();
  39
  40   public SynchronizerState getState();
  41
  42   /**
  43    * Gets the stat report.
  44    *
  45    * @param finalReport the final report
  46    * @return the stat report
  47    */
  48   public String getStatReport(boolean finalReport);
  49
  50   /**
  51    * Shutdown.
  52    */
  53   public void shutdown();
  54
  55   public String getIndexName();
  56
  57   /**
  58    * Clear cache.
  59    */
  60   public void clearCache();
  61
  62
  63 }