Initial commit for AAI-UI(sparky-backend)
[aai/sparky-be.git] / src / main / java / org / openecomp / sparky / synchronizer / 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
26 package org.openecomp.sparky.synchronizer;
27
28 import org.openecomp.sparky.synchronizer.enumeration.OperationState;
29 import org.openecomp.sparky.synchronizer.enumeration.SynchronizerState;
30
31 /**
32  * The Interface IndexSynchronizer.
33  *
34  * @author davea.
35  */
36 public interface IndexSynchronizer {
37
38   /**
39    * Do sync.
40    *
41    * @return the operation state
42    */
43   public OperationState doSync();
44
45   public SynchronizerState getState();
46
47   /**
48    * Gets the stat report.
49    *
50    * @param finalReport the final report
51    * @return the stat report
52    */
53   public String getStatReport(boolean finalReport);
54
55   /**
56    * Shutdown.
57    */
58   public void shutdown();
59
60   public String getIndexName();
61
62   /**
63    * Clear cache.
64    */
65   public void clearCache();
66
67
68 }