2 * Copyright (c) 2014 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
9 package org.opendaylight.openflowplugin.applications.frm;
11 import org.opendaylight.openflowplugin.applications.frm.impl.ForwardingRulesManagerConfig;
12 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
14 import org.opendaylight.openflowplugin.applications.frm.impl.FlowNodeConnectorInventoryTranslatorImpl;
15 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
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.meters.Meter;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.SalGroupService;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.SalMeterService;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.SalTableService;
24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
27 * forwardingrules-manager
28 * org.opendaylight.openflowplugin.applications.frm
30 * ForwardingRulesManager
31 * It represent a central point for whole modul. Implementation
32 * Flow Provider registers the link FlowChangeListener} and it holds all needed
33 * services for link FlowChangeListener}.
35 * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
37 * Created: Aug 25, 2014
39 public interface ForwardingRulesManager extends AutoCloseable {
44 * Method returns information :
45 * "is Node with send InstanceIdentifier connected"?
47 * @param ident - the key of the node
48 * @return boolean - true if device is connected
50 public boolean isNodeActive(InstanceIdentifier<FlowCapableNode> ident);
53 * Method returns information :
54 * "is Node with send InstanceIdentifier present in operational data store"?
56 * @param ident - the key of the node
57 * @return boolean - true if device is present in operational data store
59 public boolean checkNodeInOperationalDataStore(InstanceIdentifier<FlowCapableNode> ident);
62 * Method add new {@link FlowCapableNode} to active Node Holder.
63 * ActiveNodeHolder prevent unnecessary Operational/DS read for identify
64 * pre-configure and serious Configure/DS transactions.
66 * @param ident - the key of the node
68 public void registrateNewNode(InstanceIdentifier<FlowCapableNode> ident);
71 * Method remove disconnected {@link FlowCapableNode} from active Node
72 * Holder. And all next flows or groups or meters will stay in Config/DS
75 * @param ident - the key of the node
77 public void unregistrateNode(InstanceIdentifier<FlowCapableNode> ident);
80 * Method returns generated transaction ID, which is unique for
81 * every transaction. ID is composite from prefix ("DOM") and unique number.
83 * @return String transactionID for RPC transaction identification
85 public String getNewTransactionId();
88 * Method returns Read Transacion. It is need for Node reconciliation only.
90 * @return ReadOnlyTransaction
92 public ReadOnlyTransaction getReadTranaction();
99 public SalFlowService getSalFlowService();
106 public SalGroupService getSalGroupService();
113 public SalMeterService getSalMeterService();
120 public SalTableService getSalTableService();
123 * Content definition method and prevent code duplicity in Reconcil
124 * @return ForwardingRulesCommiter<Flow>
126 public ForwardingRulesCommiter<Flow> getFlowCommiter();
129 * Content definition method and prevent code duplicity in Reconcil
130 * @return ForwardingRulesCommiter<Group>
132 public ForwardingRulesCommiter<Group> getGroupCommiter();
135 * Content definition method and prevent code duplicity
136 * @return ForwardingRulesCommiter<Meter>
138 public ForwardingRulesCommiter<Meter> getMeterCommiter();
141 * Content definition method and prevent code duplicity
142 * @return ForwardingRulesCommiter<Table>
144 public ForwardingRulesCommiter<TableFeatures> getTableFeaturesCommiter();
147 * Content definition method
148 * @return FlowNodeReconciliation
150 public FlowNodeReconciliation getFlowNodeReconciliation();
153 * Returns the config-subsystem/fallback configuration of FRM
154 * @return ForwardingRulesManagerConfig
156 public ForwardingRulesManagerConfig getConfiguration();
159 * Method checks if *this* instance of openflowplugin is owner of
160 * the given openflow node.
161 * @return True if owner, else false
163 public boolean isNodeOwner(InstanceIdentifier<FlowCapableNode> ident);
166 * Content definition method and prevent code duplicity
167 * @return FlowNodeConnectorInventoryTranslatorImpl
169 public FlowNodeConnectorInventoryTranslatorImpl getFlowNodeConnectorInventoryTranslatorImpl();