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