openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/registry/flow/DeviceFlowRegistry.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
   9 package org.opendaylight.openflowplugin.api.openflow.registry.flow;
  10
  11
  12 import com.google.common.base.Optional;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import java.util.List;
  15 import java.util.Map;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  18
  19 /**
  20  * Registry for mapping composite-key of flow ({@link FlowRegistryKey}) from device view
  21  * to flow descriptor ({@link FlowDescriptor}) as the identifier of the same flow in data store.
  22  */
  23 public interface DeviceFlowRegistry extends AutoCloseable {
  24
  25     ListenableFuture<List<Optional<FlowCapableNode>>> fill();
  26
  27     FlowDescriptor retrieveIdForFlow(FlowRegistryKey flowRegistryKey);
  28
  29     void store(FlowRegistryKey flowRegistryKey, FlowDescriptor flowDescriptor);
  30
  31     FlowId storeIfNecessary(FlowRegistryKey flowRegistryKey);
  32
  33     void removeDescriptor(FlowRegistryKey flowRegistryKey);
  34
  35     void update(FlowRegistryKey newFlowRegistryKey,FlowDescriptor flowDescriptor);
  36
  37     Map<FlowRegistryKey, FlowDescriptor> getAllFlowDescriptors();
  38
  39     @Override
  40     void close();
  41 }