opendaylight/md-sal/eos-dom-akka/src/main/java/org/opendaylight/controller/eos/akka/NativeEosService.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.eos.akka;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12
  13 /**
  14  * Service used to bring up/down the NativeEos service in individual datacenters.
  15  * Active datacenter in native eos terms means that the candidates from this datacenter can become owners of entities.
  16  * Additionally the singleton component makings ownership decisions, runs only in an active datacenter.
  17  *
  18  * <p>
  19  * Caller must make sure that only one datacenter is active at a time, otherwise the singleton actors
  20  * in each datacenter will interfere with each other. The methods provided byt this service can be called
  21  * on any node from the datacenter to be activated. Datacenters only need to brought up when using non-default
  22  * datacenter or multiple datacenters.
  23  */
  24 @Beta
  25 public interface NativeEosService {
  26
  27     /**
  28      * Activates the native eos service in the datacenter that this method is called.
  29      */
  30     ListenableFuture<Void> activateDataCenter();
  31
  32     /**
  33      * Deactivates the native eos service in the datacenter that this method is called.
  34      */
  35     ListenableFuture<Void> deactivateDataCenter();
  36 }