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
  36   boolean isPeriodicSyncEnabled();
  37
  38   boolean isRunOnceSyncEnabled();
  39
  40   /**
  41    * Perform action.
  42    *
  43    * @param requestedAction the requested action
  44    * @return
  45    */
  46   OperationState performAction(SyncActions requestedAction);
  47
  48   /**
  49    * Register entity synchronizer.
  50    *
  51    * @param entitySynchronizer the entity synchronizer
  52    */
  53   void registerEntitySynchronizer(IndexSynchronizer entitySynchronizer);
  54
  55   /**
  56    * Register index validator.
  57    *
  58    * @param indexValidator the index validator
  59    */
  60   void registerIndexValidator(IndexValidator indexValidator);
  61
  62   /**
  63    * Register index cleaner.
  64    *
  65    * @param indexCleaner the index cleaner
  66    */
  67   void registerIndexCleaner(IndexCleaner indexCleaner);
  68
  69   /**
  70    * Shutdown.
  71    */
  72   void shutdown();
  73
  74   SynchronizerState getState();
  75
  76   long getDelayInMs();
  77
  78   void setDelayInMs(long delayInMs);
  79
  80   long getSyncFrequencyInMs();
  81
  82   void setSyncFrequencyInMs(long syncFrequencyInMs);
  83
  84   Date getSyncStartTime();
  85
  86   void setSyncStartTime(Date syncStartTime);
  87
  88   Date getLastExecutionDate();
  89
  90   void setLastExecutionDate(Date lastExecutionDate);
  91
  92   Calendar getCreationTime();
  93
  94   String getNextSyncTime();
  95
  96 }