[onosfw.git] /

/*\r
 * Copyright 2015 Open Networking Laboratory\r
 *\r
 * Licensed under the Apache License, Version 2.0 (the "License");\r
 * you may not use this file except in compliance with the License.\r
 * You may obtain a copy of the License at\r
 *\r
 *     http://www.apache.org/licenses/LICENSE-2.0\r
 *\r
 * Unless required by applicable law or agreed to in writing, software\r
 * distributed under the License is distributed on an "AS IS" BASIS,\r
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
 * See the License for the specific language governing permissions and\r
 * limitations under the License.\r
 */\r
package org.onosproject.bgpio.protocol.linkstate;\r
\r
import java.util.List;\r
\r
import org.jboss.netty.buffer.ChannelBuffer;\r
import org.onosproject.bgpio.exceptions.BgpParseException;\r
import org.onosproject.bgpio.protocol.BgpLinkLsNlri;\r
import org.onosproject.bgpio.protocol.NlriType;\r
import org.onosproject.bgpio.protocol.linkstate.BgpNodeLSNlriVer4.ProtocolType;\r
import org.onosproject.bgpio.types.BgpErrorType;\r
import org.onosproject.bgpio.types.BgpValueType;\r
import org.onosproject.bgpio.types.RouteDistinguisher;\r
import org.onosproject.bgpio.util.Constants;\r
import org.slf4j.Logger;\r
import org.slf4j.LoggerFactory;\r
\r
import com.google.common.base.MoreObjects;\r
\r
/**\r
 * Implementation of Link LS NLRI.\r
 */\r
public class BgpLinkLsNlriVer4 implements BgpLinkLsNlri {\r
\r
    /*\r
     * REFERENCE : draft-ietf-idr-ls-distribution-11\r
          0                   1                   2                   3\r
          0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1\r
         +-+-+-+-+-+-+-+-+\r
         |  Protocol-ID  |\r
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\r
         |                           Identifier                          |\r
         |                            (64 bits)                          |\r
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\r
         //               Local Node Descriptors (variable)             //\r
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\r
         //               Remote Node Descriptors (variable)            //\r
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\r
         //                  Link Descriptors (variable)                //\r
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\r
\r
                          Figure : The Link NLRI format\r
     */\r
    private static final Logger log = LoggerFactory.getLogger(BgpLinkLsNlriVer4.class);\r
    public static final int LINK_NLRITYPE = 2;\r
\r
    private BgpLinkLSIdentifier linkLSIdentifier;\r
    private byte protocolId;\r
    private long identifier;\r
    private RouteDistinguisher routeDistinguisher;\r
    private boolean isVpn;\r
\r
    /**\r
     * Initialize fields.\r
     */\r
    public BgpLinkLsNlriVer4() {\r
        this.protocolId = 0;\r
        this.identifier = 0;\r
        this.linkLSIdentifier = null;\r
        this.routeDistinguisher = null;\r
        this.isVpn = false;\r
    }\r
\r
    /**\r
     * Constructor to initialize parameters for BGP LinkLSNlri.\r
     *\r
     * @param protocolId protocol Id\r
     * @param identifier field in BGP LinkLSNlri\r
     * @param linkLSIdentifier link LS identifier\r
     * @param routeDistinguisher route distinguisher from message\r
     * @param isVpn vpn info availability in message\r
     */\r
    public BgpLinkLsNlriVer4(byte protocolId, long identifier, BgpLinkLSIdentifier linkLSIdentifier,\r
                             RouteDistinguisher routeDistinguisher, boolean isVpn) {\r
        this.protocolId = protocolId;\r
        this.identifier = identifier;\r
        this.linkLSIdentifier = linkLSIdentifier;\r
        this.routeDistinguisher = routeDistinguisher;\r
        this.isVpn = isVpn;\r
    }\r
\r
    /**\r
     * Reads from channelBuffer and parses Link LS Nlri.\r
     *\r
     * @param cb ChannelBuffer\r
     * @param afi Address Family Identifier\r
     * @param safi Subsequent Address Family Identifier\r
     * @return object of this class\r
     * @throws BgpParseException while parsing Link LS NLRI\r
     */\r
    public static BgpLinkLsNlriVer4 read(ChannelBuffer cb, short afi, byte safi) throws BgpParseException {\r
        boolean isVpn = false;\r
        RouteDistinguisher routeDistinguisher = null;\r
        if ((afi == Constants.AFI_VALUE) && (safi == Constants.VPN_SAFI_VALUE)) {\r
            routeDistinguisher = new RouteDistinguisher();\r
            routeDistinguisher = RouteDistinguisher.read(cb);\r
            isVpn = true;\r
        } else {\r
            isVpn = false;\r
        }\r
        byte protocolId = cb.readByte();\r
        long identifier = cb.readLong();\r
\r
        BgpLinkLSIdentifier linkLSIdentifier = new BgpLinkLSIdentifier();\r
        linkLSIdentifier = BgpLinkLSIdentifier.parseLinkIdendifier(cb, protocolId);\r
        return new BgpLinkLsNlriVer4(protocolId, identifier, linkLSIdentifier, routeDistinguisher, isVpn);\r
    }\r
\r
    @Override\r
    public NlriType getNlriType() {\r
        return NlriType.LINK;\r
    }\r
\r
    @Override\r
    public long getIdentifier() {\r
        return this.identifier;\r
    }\r
\r
    /**\r
     * Set the link LS identifier.\r
     *\r
     * @param linkLSIdentifier link LS identifier to set\r
     */\r
    public void setLinkLSIdentifier(BgpLinkLSIdentifier linkLSIdentifier) {\r
        this.linkLSIdentifier = linkLSIdentifier;\r
    }\r
\r
    @Override\r
    public ProtocolType getProtocolId() throws BgpParseException {\r
        switch (protocolId) {\r
        case Constants.ISIS_LEVELONE:\r
            return ProtocolType.ISIS_LEVEL_ONE;\r
        case Constants.ISIS_LEVELTWO:\r
            return ProtocolType.ISIS_LEVEL_TWO;\r
        case Constants.OSPFV2:\r
            return ProtocolType.OSPF_V2;\r
        case Constants.DIRECT:\r
            return ProtocolType.DIRECT;\r
        case Constants.STATIC_CONFIGURATION:\r
            return ProtocolType.STATIC_CONFIGURATION;\r
        case Constants.OSPFV3:\r
            return ProtocolType.OSPF_V3;\r
        default:\r
            throw new BgpParseException(BgpErrorType.UPDATE_MESSAGE_ERROR, (byte) 0, null);\r
        }\r
    }\r
\r
    @Override\r
    public NodeDescriptors localNodeDescriptors() {\r
        return this.linkLSIdentifier.localNodeDescriptors();\r
    }\r
\r
    @Override\r
    public NodeDescriptors remoteNodeDescriptors() {\r
        return this.linkLSIdentifier.remoteNodeDescriptors();\r
    }\r
\r
    /**\r
     * Returns whether VPN is present or not.\r
     *\r
     * @return whether VPN is present or not\r
     */\r
    public boolean isVpnPresent() {\r
        return this.isVpn;\r
    }\r
\r
    @Override\r
    public RouteDistinguisher getRouteDistinguisher() {\r
        return this.routeDistinguisher;\r
    }\r
\r
    /**\r
     * Returns link identifier.\r
     *\r
     * @return link identifier\r
     */\r
    public BgpLinkLSIdentifier getLinkIdentifier() {\r
        return this.linkLSIdentifier;\r
    }\r
\r
    @Override\r
    public List<BgpValueType> linkDescriptors() {\r
        return this.linkLSIdentifier.linkDescriptors();\r
    }\r
\r
    @Override\r
    public String toString() {\r
        return MoreObjects.toStringHelper(getClass())\r
                .omitNullValues()\r
                .add("protocolId", protocolId)\r
                .add("identifier", identifier)\r
                .add("RouteDistinguisher ", routeDistinguisher)\r
                .add("linkLSIdentifier", linkLSIdentifier)\r
                .toString();\r
    }\r
}\r