openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/OFPContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.openflowplugin.api.openflow;
   9
  10 import com.google.common.util.concurrent.Futures;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import java.util.concurrent.ExecutionException;
  13 import java.util.concurrent.RejectedExecutionException;
  14 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  15 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  16
  17 /**
  18  * General API for all OFP Context
  19  */
  20 public interface OFPContext {
  21
  22     default void setState(CONTEXT_STATE contextState) {
  23         //NOOP
  24     }
  25
  26     /**
  27      * Context state
  28      */
  29     enum CONTEXT_STATE {
  30         /* Initialization phase, context not yet fully initialized */
  31         INITIALIZATION,
  32         /* Standard working phase everything is fine */
  33         WORKING,
  34         /* Termination phase context is being shutting down */
  35         TERMINATION
  36     }
  37
  38     /**
  39      * @return actual context state
  40      */
  41     CONTEXT_STATE getState();
  42
  43     /**
  44      * Starting cluster services for context becoming master
  45      */
  46     default void startupClusterServices() throws ExecutionException, InterruptedException {
  47         throw new InterruptedException("Cannot start abstract service, check implementation of cluster services");
  48     }
  49
  50     /**
  51      * About to stop services in cluster not master anymore or going down
  52      * @return Future most of services need time to be closed
  53      */
  54     default ListenableFuture<Void> stopClusterServices(){
  55         return Futures.immediateFailedFuture(new RejectedExecutionException("Cannot stop abstract services, check implementation of cluster services"));
  56     }
  57
  58     /**
  59      * @return cluster singleton service identifier
  60      */
  61     ServiceGroupIdentifier getServiceIdentifier();
  62
  63     /**
  64      * @return device info
  65      */
  66     DeviceInfo getDeviceInfo();
  67
  68 }