blob: 16374d5bb23806c6aaf61b8a2692abd25390433d (
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* 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.pcepio.protocol;
import java.util.LinkedList;
import org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.pcepio.exceptions.PcepParseException;
import org.onosproject.pcepio.types.PcepObjectHeader;
import org.onosproject.pcepio.types.PcepValueType;
/**
* Abstraction of an entity providing PCEP Error Object.
*/
public interface PcepErrorObject {
/**
* Returns Error Type in Error Object.
*
* @return Error Type in Error Object
*/
int getErrorType();
/**
* Sets Error Type in Error Object.
*
* @param value Error Type
*/
void setErrorType(byte value);
/**
* Returns Error Value in Error Object.
*
* @return Error Value
*/
byte getErrorValue();
/**
* Sets Error Value in Error Object.
*
* @param value Error Value
*/
void setErrorValue(byte value);
/**
* Returns Optional Tlvs in Error Object.
*
* @return list of Optional Tlvs in Error Object
*/
LinkedList<PcepValueType> getOptionalTlv();
/**
* Sets Optional Tlvs in Error Object.
*
* @param llOptionalTlv list of Optional Tlvs
*/
void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv);
/**
* Writes the Error Object into channel buffer.
*
* @param bb channel buffer
* @return Returns the writerIndex of this buffer
* @throws PcepParseException while writing Error Object into ChannelBuffer
*/
int write(ChannelBuffer bb) throws PcepParseException;
/**
* Builder interface with get and set functions to build Error object.
*/
interface Builder {
/**
* Builds Error Object.
*
* @return Error Object.
*/
PcepErrorObject build();
/**
* Returns Error Object header.
*
* @return Error Object header
*/
PcepObjectHeader getErrorObjHeader();
/**
* Sets Error Object header and returns its Builder.
*
* @param obj Error Object header
* @return Builder by setting Error Object header
*/
Builder setErrorObjHeader(PcepObjectHeader obj);
/**
* Returns Error Type in Error Object.
*
* @return Error Type in Error Object
*/
int getErrorType();
/**
* Sets Error Type and returns its builder.
*
* @param value of Error-Type field
* @return builder by setting Error Type field.
*/
Builder setErrorType(byte value);
/**
* Returns Error Value in Error Object.
*
* @return Error Value
*/
byte getErrorValue();
/**
* Sets Error Value and returns its builder.
*
* @param value of Error-Value field
* @return Builder by setting Error Value field.
*/
Builder setErrorValue(byte value);
/**
* Returns list of Optional Tlvs of Error Object.
*
* @return list of Optional Tlvs of Error Object
*/
LinkedList<PcepValueType> getOptionalTlv();
/**
* Sets Optional Tlvs of Error Object and returns its Builder.
*
* @param llOptionalTlv Optional Tlvs of Error Object
* @return Builder by setting Optional Tlvs.
*/
Builder setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv);
/**
* Sets P flag in Error object header and returns its builder.
*
* @param value boolean value to set P flag
* @return Builder by setting P flag
*/
Builder setPFlag(boolean value);
/**
* Sets I flag in Error object header and returns its builder.
*
* @param value boolean value to set I flag
* @return Builder by setting I flag
*/
Builder setIFlag(boolean value);
}
}
|
