sparkybe-onap-service/src/main/java/org/onap/aai/sparky/sync/IndexSynchronizer.java

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   8  * ============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=====================================================
  21  *
  22  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25 package org.onap.aai.sparky.sync;
  26
  27 import org.onap.aai.sparky.sync.enumeration.OperationState;
  28 import org.onap.aai.sparky.sync.enumeration.SynchronizerState;
  29
  30 /**
  31  * The Interface IndexSynchronizer.
  32  *
  33  * @author davea.
  34  */
  35 public interface IndexSynchronizer {
  36
  37   /**
  38    * Do sync.
  39    *
  40    * @return the operation state
  41    */
  42   public OperationState doSync();
  43
  44   public SynchronizerState getState();
  45
  46   /**
  47    * Gets the stat report.
  48    *
  49    * @param finalReport the final report
  50    * @return the stat report
  51    */
  52   public String getStatReport(boolean finalReport);
  53
  54   /**
  55    * Shutdown.
  56    */
  57   public void shutdown();
  58
  59   public String getIndexName();
  60
  61   /**
  62    * Clear cache.
  63    */
  64   public void clearCache();
  65
  66
  67 }