OfTable.java

/*
 * 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.groupbasedpolicy.renderer.ofoverlay.flow;

import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfWriter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Manage the state of a openflow  table by reacting to any events and updating
 * the table state.  This is an abstract class that must be extended for
 * each specific table being managed.
 * @author readams
 */
public abstract class OfTable {

    protected static final Logger LOG = LoggerFactory.getLogger(OfTable.class);

    protected final OfContext ctx;

    public OfTable(OfContext ctx) {
        this.ctx = ctx;
    }

    /**
     * Update the relevant flow table for the node
     *
     * @param endpoint flows will be created for
     * @param ofWriter the {@link OfWriter}
     * @throws Exception throws all exception
     */
    public abstract void sync(Endpoint endpoint, OfWriter ofWriter)
            throws Exception;
}