src/main/java/org/onap/aai/sparky/sync/SyncController.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  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23 package org.onap.aai.sparky.sync;
  24
  25 import java.util.Calendar;
  26 import java.util.Date;
  27
  28 import org.onap.aai.sparky.sync.SyncControllerImpl.SyncActions;
  29 import org.onap.aai.sparky.sync.enumeration.OperationState;
  30 import org.onap.aai.sparky.sync.enumeration.SynchronizerState;
  31
  32 public interface SyncController {
  33
  34   String getControllerName();
  35   boolean isPeriodicSyncEnabled();
  36   boolean isRunOnceSyncEnabled();
  37
  38   /**
  39    * Perform action.
  40    *
  41    * @param requestedAction the requested action
  42    * @return
  43    */
  44   OperationState performAction(SyncActions requestedAction);
  45
  46   /**
  47    * Register entity synchronizer.
  48    *
  49    * @param entitySynchronizer the entity synchronizer
  50    */
  51   void registerEntitySynchronizer(IndexSynchronizer entitySynchronizer);
  52
  53   /**
  54    * Register index validator.
  55    *
  56    * @param indexValidator the index validator
  57    */
  58   void registerIndexValidator(IndexValidator indexValidator);
  59
  60   /**
  61    * Register index cleaner.
  62    *
  63    * @param indexCleaner the index cleaner
  64    */
  65   void registerIndexCleaner(IndexCleaner indexCleaner);
  66
  67   /**
  68    * Shutdown.
  69    */
  70   void shutdown();
  71
  72   SynchronizerState getState();
  73
  74   long getDelayInMs();
  75
  76   void setDelayInMs(long delayInMs);
  77
  78   long getSyncFrequencyInMs();
  79
  80   void setSyncFrequencyInMs(long syncFrequencyInMs);
  81
  82   Date getSyncStartTime();
  83
  84   void setSyncStartTime(Date syncStartTime);
  85
  86   Date getLastExecutionDate();
  87
  88   void setLastExecutionDate(Date lastExecutionDate);
  89
  90   Calendar getCreationTime();
  91
  92   String getNextSyncTime();
  93
  94 }