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.ListenableFuture;
  11 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  12 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  13 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
  14 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterLifecycleSupervisor;
  15
  16 /**
  17  * General API for all OFP Context.
  18  */
  19 public interface OFPContext extends AutoCloseable, ClusterLifecycleSupervisor, ClusterInitializationPhaseHandler {
  20
  21
  22     /**
  23      * Context state.
  24      */
  25     enum ContextState {
  26         /* Initialization phase, context not yet fully initialized */
  27         INITIALIZATION,
  28         /* Standard working phase everything is fine */
  29         WORKING,
  30         /* Termination phase context is being shutting down */
  31         TERMINATION
  32     }
  33
  34     /**
  35      * Get actual context state.
  36      * @return actual context state
  37      */
  38     ContextState getState();
  39
  40     /**
  41      * About to stop services in cluster not master anymore or going down.
  42      * @return Future most of services need time to be closed.
  43      */
  44     ListenableFuture<Void> stopClusterServices();
  45
  46     /**
  47      * Get cluster singleton service identifier.
  48      * @return cluster singleton service identifier.
  49      */
  50     ServiceGroupIdentifier getServiceIdentifier();
  51
  52     /**
  53      * Get device info.
  54      * @return device info
  55      */
  56     DeviceInfo getDeviceInfo();
  57
  58     @Override
  59     void close();
  60 }