apps/castor/src/main/java/org/onosproject/castor/CastorStore.java

/*
 * Copyright 2016-present Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.castor;

import org.onlab.packet.IpAddress;
import org.onlab.packet.MacAddress;
import org.onosproject.net.intent.Key;
import org.onosproject.net.intent.MultiPointToSinglePointIntent;
import org.onosproject.net.intent.PointToPointIntent;

import java.util.Map;
import java.util.Set;

/**
 * Interface to access Castor Distributed Store.
 */
public interface CastorStore {

    /**
     *Returns list of all peers including the route servers.
     *
     * @return list of Peer
     */
    Set<Peer> getAllPeers();

    /**
     * Store a Peer.
     *
     * @param peer The Peer to store
     */
    void storePeer(Peer peer);

    /**
     * Get the Route Servers.
     *
     * @return List of Servers
     */
    Set<Peer> getServers();

    /**
     * Store a Route Server.
     *
     * @param peer The Server
     */
    void storeServer(Peer peer);

    /**
     * Returns the list of added BGP Peers.
     *
     * @return List of Peer
     */
    Set<Peer> getCustomers();

    /**
     * Store a Customer.
     *
     * @param peer The Customer to be stored
     */
    void storeCustomer(Peer peer);

    /**
     * Returns the map of currently known mac addresses from ARP.
     *
     * @return map of IP address to Mac
     */
    Map<IpAddress, MacAddress> getAddressMap();

    /**
     * Sets the mapping from IP address to Mac.
     *
     * @param ip IP Address
     * @param mac MAC Address
     */
    void setAddressMap(IpAddress ip, MacAddress mac);

    /**
     * Returns all the peer intents.
     *
     * @return PointToPointIntent
     */
    Map<Key, PointToPointIntent> getPeerIntents();

    /**
     * Stores a Peer Intent.
     *
     * @param key The intent
     * @param intent Key
     */
    void storePeerIntent(Key key, PointToPointIntent intent);

    /**
     * Returns layer2 intents.
     *
     * @return MultiPointToSinglePointIntent
     */
    Map<String, MultiPointToSinglePointIntent> getLayer2Intents();

    /**
     * Stores a layer2 intent.
     *
     * @param key Key
     * @param intent The intent
     */
    void storeLayer2Intent(String key, MultiPointToSinglePointIntent intent);

    /**
     * Returns the mapping of Customer names to their IP address.
     *
     * @return HashMap
     */
    Map<String, String> getCustomersMap();

    /**
     * Removes a customer and its associated flows from the network.
     *
     * @param peer The Customer
     */
    void removeCustomer(Peer peer);

    /**
     * Removes a peer intent from the store.
     *
     * @param key Key for the intent
     */
    void removePeerIntent(Key key);

    /**
     * Removes the layer2 intent from the store.
     *
     * @param key Key for intent
     */
    void removeLayer2Intent(String key);
}