/**
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.frm;
import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
* forwardingrules-manager
* org.opendaylight.controller.frm
*
* ForwardingRulesCommiter
* It represent a contract between DataStore DataChangeEvent and relevant
* SalRpcService for device. Every implementation has to be registered for
* Configurational/DS tree path.
*
* @author Vaclav Demcak
*
* Created: Aug 25, 2014
*/
public interface ForwardingRulesCommiter extends AutoCloseable, DataChangeListener {
/**
* Method removes DataObject which is identified by InstanceIdentifier
* from device.
*
* @param InstanceIdentifier identifier - the whole path to DataObject
* @param DataObject remove - DataObject for removing
* @param InstanceIdentifier parent Node InstanceIdentifier
*/
void remove(InstanceIdentifier identifier, D del,
InstanceIdentifier nodeIdent);
/**
* Method updates the original DataObject to the update DataObject
* in device. Both are identified by same InstanceIdentifier
*
* @param InstanceIdentifier identifier - the whole path to DataObject
* @param DataObject original - original DataObject (for update)
* @param DataObject update - changed DataObject (contain updates)
*/
void update(InstanceIdentifier identifier, D original, D update,
InstanceIdentifier nodeIdent);
/**
* Method adds the DataObject which is identified by InstanceIdentifier
* to device.
*
* @param InstanceIdentifier identifier - the whole path to new DataObject
* @param DataObject add - new DataObject
*/
void add(InstanceIdentifier identifier, D add,
InstanceIdentifier nodeIdent);
}