aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/protocols/pcep/pcepio/src/main/java/org/onosproject/pcepio/protocol/PcepTEObject.java
blob: 21f6c71c7fd51f1c51c36d8b0a88df70b0844e2f (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
 * 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 TE Object.
 */
public interface PcepTEObject {

    /**
     * Returns TE object header.
     *
     * @return TE object header
     */
    PcepObjectHeader getTEObjHeader();

    /**
     * Sets TE Object header.
     *
     * @param obj TE Object header
     */
    void setTEObjHeader(PcepObjectHeader obj);

    /**
     * Returns ProtocolId in TE Object.
     *
     * @return ProtocolId in TE Object
     */
    byte getProtocolId();

    /**
     * Sets ProtocolId in TE Object.
     *
     * @param yProtId ProtocolId in TE Object
     */
    void setProtocolId(byte yProtId);

    /**
     * Returns R flag in TE Object.
     *
     * @return R flag in TE Object
     */
    boolean getRFlag();

    /**
     * Sets R flag in TE Object.
     *
     * @param bRFlag R flag in TE Object
     */
    void setRFlag(boolean bRFlag);

    /**
     * Returns S flag in TE Object.
     *
     * @return S flag in TE Object
     */
    boolean getSFlag();

    /**
     * Sets S flag in TE Object.
     *
     * @param bSFlag S flag in TE Object
     */
    void setSFlag(boolean bSFlag);

    /**
     * Returns TE ID in TE Object.
     *
     * @return TE ID in TE Object
     */
    int getTEId();

    /**
     * Sets TE ID in TE Object.
     *
     * @param iTEId TE ID in TE Object
     */
    void setTEId(int iTEId);

    /**
     * Returns list of Optional Tlvs in TE Object.
     *
     * @return list of Optional Tlvs
     */
    LinkedList<PcepValueType> getOptionalTlv();

    /**
     * Sets list of Optional Tlvs in TE Object.
     *
     * @param llOptionalTlv list of Optional Tlvs
     */
    void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv);

    /**
     * Writes the TE Object into channel buffer.
     *
     * @param bb channel buffer
     * @return Returns the writerIndex of this buffer
     * @throws PcepParseException when obj header is not written to channel buffer
     */
    int write(ChannelBuffer bb) throws PcepParseException;

    /**
     * Builder interface with get and set functions to build TE object.
     */
    interface Builder {

        /**
         * Builds TE Object.
         *
         * @return TE Object
         */
        PcepTEObject build();

        /**
         * Returns TE object header.
         *
         * @return TE object header
         */
        PcepObjectHeader getTEObjHeader();

        /**
         * Sets TE object header and returns its builder.
         *
         * @param obj TE object header
         * @return Builder by setting TE object header
         */
        Builder setTEObjHeader(PcepObjectHeader obj);

        /**
         * Returns ProtocolId in TE Object.
         *
         * @return ProtocolId in TE Object
         */
        byte getProtocolId();

        /**
         * Sets ProtocolId in TE Object and returns its builder.
         *
         * @param yProtId ProtocolId in TE Object
         * @return Builder by setting ProtocolId
         */
        Builder setProtocolId(byte yProtId);

        /**
         * Returns R flag in TE Object.
         *
         * @return R flag in TE Object
         */
        boolean getRFlag();

        /**
         * Sets R flag in TE Object and returns its builder.
         *
         * @param bRFlag R flag in TE Object
         * @return Builder by setting R flag
         */
        Builder setRFlag(boolean bRFlag);

        /**
         * Returns S flag in TE Object.
         *
         * @return S flag in TE Object
         */
        boolean getSFlag();

        /**
         * Sets S flag in TE Object and returns its builder.
         *
         * @param bSFlag S flag in TE Object
         * @return Builder by setting S flag
         */
        Builder setSFlag(boolean bSFlag);

        /**
         * Returns TE ID in TE Object.
         *
         * @return TE ID in TE Object
         */
        int getTEId();

        /**
         * Sets TE ID in TE Object and returns its builder.
         *
         * @param iTEId TE ID in TE Object
         * @return Builder by setting TE ID
         */
        Builder setTEId(int iTEId);

        /**
         * Returns list of Optional Tlvs in TE Object.
         *
         * @return list of Optional Tlvs
         */
        LinkedList<PcepValueType> getOptionalTlv();

        /**
         * Sets list of Optional Tlvs in TE Object and returns its builder.
         *
         * @param llOptionalTlv list of Optional Tlvs
         * @return Builder by setting list of Optional Tlvs
         */
        Builder setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv);

        /**
         * Sets P flag in TE 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 TE object header and returns its builder.
         *
         * @param value boolean value to set I flag
         * @return Builder by setting I flag
         */
        Builder setIFlag(boolean value);
    }
}