icona/domainprovider/src/main/java/org/onosproject/icona/domainprovider/api/IconaSBTopologyListener.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * 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.icona.domainprovider.api;

import com.google.common.annotations.Beta;
import org.onosproject.icona.domainmgr.api.DomainId;

import java.util.Map;

/**
 * Methods implemented by the southbound components to send the complete local topology to another domain.
 */
public interface IconaSBTopologyListener {

    /**
     * Configures the local topology exposed to a domain, based on configuration policies.
     *
     * @param topologyMap a map with the domain id as the key and the topology object as the value
     */
    void configTopology(Map<DomainId, DomainTopology> topologyMap);


    /**
     * Remove a complete topology configuration exposed to a domain.
     *
     * @param domainId domain identifier
     */
    @Beta
    void removeConfigTopology(DomainId domainId);
}