blob: bf5d05f4ceee0be5398aa32adf1b158f222870d3 (
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* 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 java.util.LinkedList;
import org.onosproject.bgpio.exceptions.BGPParseException;
import org.onosproject.bgpio.types.BGPHeader;
import org.onosproject.bgpio.types.BGPValueType;
/**
* Abstraction of an entity providing BGP Open Message.
*/
public interface BGPOpenMsg extends BGPMessage {
@Override
BGPHeader getHeader();
@Override
BGPVersion getVersion();
@Override
BGPType getType();
/**
* Returns hold time of Open Message.
*
* @return hold time of Open Message
*/
short getHoldTime();
/**
* Returns AS Number of Open Message.
*
* @return AS Number of Open Message
*/
short getAsNumber();
/**
* Returns BGP Identifier of Open Message.
*
* @return BGP Identifier of Open Message
*/
int getBgpId();
/**
* Returns capabilities of Open Message.
*
* @return capabilities of Open Message
*/
LinkedList<BGPValueType> getCapabilityTlv();
/**
* Builder interface with get and set functions to build Open message.
*/
interface Builder extends BGPMessage.Builder {
@Override
BGPOpenMsg build() throws BGPParseException;
/**
* Sets hold time in Open Message and return its builder.
*
* @param holdtime hold timer value in open message
* @return builder by setting hold time
*/
Builder setHoldTime(short holdtime);
/**
* Sets AS number in Open Message and return its builder.
*
* @param asNumber as number in open message
* @return builder by setting asNumber
*/
Builder setAsNumber(short asNumber);
/**
* Sets BGP Identifier in Open Message and return its builder.
*
* @param bgpId BGP Identifier in open message
* @return builder by setting BGP Identifier
*/
Builder setBgpId(int bgpId);
/**
* Sets capabilities in Open Message and return its builder.
*
* @param capabilityTlv capabilities in open message
* @return builder by setting capabilities
*/
Builder setCapabilityTlv(LinkedList<BGPValueType> capabilityTlv);
/**
* Sets isLargeAsCapabilityTlvSet and return its builder.
*
* @param isLargeAsCapabilitySet
* boolean value to know whether large AS capability is set or not
* @return builder by setting capabilities
*/
Builder setLargeAsCapabilityTlv(boolean isLargeAsCapabilitySet);
/**
* Sets isLsCapabilityTlvSet and return its builder.
*
* @param isLsCapabilitySet
* boolean value to know whether LS capability is set or not
* @return builder by setting capabilities
*/
Builder setLsCapabilityTlv(boolean isLsCapabilitySet);
@Override
Builder setHeader(BGPHeader bgpMsgHeader);
}
}
|