protocols/bgp/bgpio/src/main/java/org/onosproject/bgpio/protocol/BgpUpdateMsg.java

/*
 * Copyright 2015-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.bgpio.protocol;

import java.util.List;

import org.jboss.netty.buffer.ChannelBuffer;
import org.onlab.packet.IpPrefix;
import org.onosproject.bgpio.protocol.ver4.BgpPathAttributes;
import org.onosproject.bgpio.types.BgpValueType;
import org.onosproject.bgpio.types.BgpHeader;

/**
 * Abstraction of an entity providing BGP Update Message.
 */
public interface BgpUpdateMsg extends BgpMessage {

    @Override
    BgpVersion getVersion();

    @Override
    BgpType getType();

    @Override
    void writeTo(ChannelBuffer channelBuffer);

    @Override
    BgpHeader getHeader();

    /**
     * Builder interface with set functions to build update message.
     */
    interface Builder extends BgpMessage.Builder {
        @Override
        BgpUpdateMsg build();

        Builder setBgpPathAttributes(List<BgpValueType> attributes);

        @Override
        Builder setHeader(BgpHeader bgpMsgHeader);
    }

    /**
     * Returns path attributes in BGP Update Message.
     *
     * @return path attributes in BGP Update Message
     */
    BgpPathAttributes bgpPathAttributes();

    /**
     * Returns withdrawn Routes.
     *
     * @return withdrawn Routes
     */
    List<IpPrefix> withdrawnRoutes();

    /**
     * Returns NLRI list of prefix.
     *
     * @return NLRI list of prefix
     */
    List<IpPrefix> nlri();
}