2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.openflowplugin.api.openflow;
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;
18 * General API for all OFP Context
20 public interface OFPContext {
22 void setState(CONTEXT_STATE contextState);
28 /* Initialization phase, context not yet fully initialized */
30 /* Standard working phase everything is fine */
32 /* Termination phase context is being shutting down */
37 * @return actual context state
39 CONTEXT_STATE getState();
42 * Starting cluster services for context becoming master
44 default void startupClusterServices() throws ExecutionException, InterruptedException {
45 throw new InterruptedException("Cannot start abstract service, check implementation of cluster services");
49 * About to stop services in cluster not master anymore or going down
50 * @return Future most of services need time to be closed
51 * @param deviceDisconnected
53 default ListenableFuture<Void> stopClusterServices(final boolean deviceDisconnected){
54 return Futures.immediateFailedFuture(new RejectedExecutionException("Cannot stop abstract services, check implementation of cluster services"));
58 * @return cluster singleton service identifier
60 ServiceGroupIdentifier getServiceIdentifier();
65 DeviceInfo getDeviceInfo();