aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/protocols/pcep/pcepio/src/main/java/org/onosproject/pcepio/protocol/PcepEndPointsObject.java
blob: 92d438745318f046da57c5b67d02ee8dfc44041d (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
/*
 * 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 org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.pcepio.exceptions.PcepParseException;
import org.onosproject.pcepio.types.PcepObjectHeader;

/**
 * Abstraction of an entity providing PCEP End Points Object.
 */
public interface PcepEndPointsObject {

    /**
     * Returns Source IpAddress from End Points Object.
     *
     * @return Source IpAddress from End Points Object
     */
    int getSourceIpAddress();

    /**
     * Sets Source IpAddress in End Points Object.
     *
     * @param sourceIpAddress Source IP Address
     */
    void setSourceIpAddress(int sourceIpAddress);

    /**
     * Returns Destination IpAddress from End Points Object.
     *
     * @return Destination IpAddress from End Points Object
     */
    int getDestIpAddress();

    /**
     * Sets Destination IpAddress in End Points Object.
     *
     * @param destIpAddress Destination IP Address
     */
    void setDestIpAddress(int destIpAddress);

    /**
     * Writes the EndPointsObject into channel buffer.
     *
     * @param bb channel buffer
     * @return Returns the writerIndex of this buffer
     * @throws PcepParseException while writing EndPointObject into ChannelBuffer
     */
    int write(ChannelBuffer bb) throws PcepParseException;

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

        /**
         * Builds End Points Object.
         *
         * @return End Points Object
         * @throws PcepParseException while building EndPointObject
         */
        PcepEndPointsObject build() throws PcepParseException;

        /**
         * Returns End Points Object header.
         *
         * @return End Points Object header
         */
        PcepObjectHeader getEndPointsObjHeader();

        /**
         * Sets End Points Object header and returns its builder.
         *
         * @param obj End Points Object header
         * @return Builder by setting End Points Object header
         */
        Builder setEndPointsObjHeader(PcepObjectHeader obj);

        /**
         * Returns Source IpAddress from End Points Object.
         *
         * @return Source IpAddress from End Points Object
         */
        int getSourceIpAddress();

        /**
         * Sets Source IpAddress in End Points Object and returns builder.
         *
         * @param sourceIpAddress Source IP Address
         * @return Builder by setting Source IpAddress in End Points Object
         */
        Builder setSourceIpAddress(int sourceIpAddress);

        /**
         * Returns Destination IpAddress from End Points Object.
         *
         * @return Destination IpAddress from End Points Object
         */
        int getDestIpAddress();

        /**
         * Sets Destination IpAddress in End Points Object.
         *
         * @param destIpAddress Destination IP Address
         * @return Builder by setting Destination IpAddress in End Points Object
         */
        Builder setDestIpAddress(int destIpAddress);

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