aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/protocol/BGPLSNlri.java
blob: 189edb8851825d95417bef05e421fd621cbef60c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*
 * Copyright 2015 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 org.onosproject.bgpio.exceptions.BGPParseException;
import org.onosproject.bgpio.protocol.linkstate.BGPNodeLSNlriVer4.PROTOCOLTYPE;
import org.onosproject.bgpio.types.RouteDistinguisher;

/**
 * Abstraction of an entity providing BGP-LS NLRI.
 */
public interface BGPLSNlri {
    /**
     * Returns NlriType of BGP-LS NLRI.
     *
     * @return NlriType of BGP-LS NLRI
     */
    NlriType getNlriType();

    /**
     * Returns Identifier in Nlri.
     *
     * @return Identifier in Nlri
     */
    long getIdentifier();

    /**
     * Returns Protocol Id in Nlri.
     *
     * @return Protocol Id in Nlri
     * @throws BGPParseException while getting protocol ID
     */
    PROTOCOLTYPE getProtocolId() throws BGPParseException;

    /**
     * Returns Route distinguisher in Nlri.
     *
     * @return Route distinguisher in Nlri
     */
    RouteDistinguisher getRouteDistinguisher();
}