sparkybe-onap-service/src/main/java/org/onap/aai/sparky/sync/SyncController.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 java.util.Calendar;
  28 import java.util.Date;
  29
  30 import org.onap.aai.sparky.sync.SyncControllerImpl.SyncActions;
  31 import org.onap.aai.sparky.sync.enumeration.OperationState;
  32 import org.onap.aai.sparky.sync.enumeration.SynchronizerState;
  33
  34 public interface SyncController {
  35
  36   String getControllerName();
  37   boolean isPeriodicSyncEnabled();
  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 }