Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.pcepio.protocol; |
| 18 | |
| 19 | import java.util.LinkedList; |
| 20 | |
| 21 | import org.jboss.netty.buffer.ChannelBuffer; |
| 22 | import org.onosproject.pcepio.exceptions.PcepParseException; |
| 23 | import org.onosproject.pcepio.types.PcepObjectHeader; |
| 24 | import org.onosproject.pcepio.types.PcepValueType; |
| 25 | |
| 26 | /** |
| 27 | * Abstraction of an entity providing PCEP SRP Object. |
| 28 | */ |
| 29 | public interface PcepSrpObject { |
| 30 | |
| 31 | /** |
| 32 | * Returns SRP ID of SRP Object. |
| 33 | * |
| 34 | * @return SRP ID of SRP Object |
| 35 | */ |
| 36 | int getSrpID(); |
| 37 | |
| 38 | /** |
| 39 | * Sets SRP ID with specified value. |
| 40 | * |
| 41 | * @param srpID SRP ID of SRP Object |
| 42 | */ |
| 43 | void setSrpID(int srpID); |
| 44 | |
| 45 | /** |
| 46 | * Returns R flag of SRP Object. |
| 47 | * |
| 48 | * @return R flag of SRP Object |
| 49 | */ |
| 50 | boolean getRFlag(); |
| 51 | |
| 52 | /** |
| 53 | * Sets R flag with specified value. |
| 54 | * |
| 55 | * @param bRFlag R Flag of SRP Object |
| 56 | */ |
| 57 | void setRFlag(boolean bRFlag); |
| 58 | |
| 59 | /** |
Avantika-Huawei | 7c14e66 | 2016-05-16 19:13:34 +0530 | [diff] [blame] | 60 | * Returns S flag of SRP Object. |
| 61 | * |
| 62 | * @return S flag of SRP Object |
| 63 | */ |
| 64 | boolean getSFlag(); |
| 65 | |
| 66 | /** |
| 67 | * Sets S(sync) flag with specified value. |
| 68 | * |
| 69 | * @param bSFlag S Flag of SRP Object |
| 70 | */ |
| 71 | void setSFlag(boolean bSFlag); |
| 72 | |
| 73 | /** |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 74 | * sets the optional TLvs. |
| 75 | * |
| 76 | * @param llOptionalTlv list of optional tlvs |
| 77 | */ |
Sho SHIMIZU | 260f6ef | 2015-08-11 13:53:31 -0700 | [diff] [blame] | 78 | void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv); |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * Returns list of optional tlvs. |
| 82 | * |
| 83 | * @return llOptionalTlv list of optional tlvs |
| 84 | */ |
Sho SHIMIZU | 260f6ef | 2015-08-11 13:53:31 -0700 | [diff] [blame] | 85 | LinkedList<PcepValueType> getOptionalTlv(); |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 86 | |
| 87 | /** |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 88 | * Writes the SRP Object into channel buffer. |
| 89 | * |
| 90 | * @param bb channel buffer |
| 91 | * @return Returns the writerIndex of this buffer |
| 92 | * @throws PcepParseException when tlv is null |
| 93 | */ |
| 94 | int write(ChannelBuffer bb) throws PcepParseException; |
| 95 | |
| 96 | /** |
| 97 | * Builder interface with get and set functions to build SRP object. |
| 98 | */ |
Sho SHIMIZU | 260f6ef | 2015-08-11 13:53:31 -0700 | [diff] [blame] | 99 | interface Builder { |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 100 | |
| 101 | /** |
| 102 | * Builds SRP Object. |
| 103 | * |
| 104 | * @return SRP Object |
| 105 | * @throws PcepParseException when mandatory object is not set |
| 106 | */ |
| 107 | PcepSrpObject build() throws PcepParseException; |
| 108 | |
| 109 | /** |
| 110 | * Returns SRP object header. |
| 111 | * |
| 112 | * @return SRP object header |
| 113 | */ |
| 114 | PcepObjectHeader getSrpObjHeader(); |
| 115 | |
| 116 | /** |
| 117 | * Sets SRP object header and returns its builder. |
| 118 | * |
| 119 | * @param obj SRP object header |
| 120 | * @return Builder by setting SRP object header |
| 121 | */ |
| 122 | Builder setSrpObjHeader(PcepObjectHeader obj); |
| 123 | |
| 124 | /** |
| 125 | * Returns SRP ID of SRP Object. |
| 126 | * |
| 127 | * @return SRP ID of SRP Object |
| 128 | */ |
| 129 | int getSrpID(); |
| 130 | |
| 131 | /** |
| 132 | * Sets SRP ID and returns its builder. |
| 133 | * |
| 134 | * @param srpID SRP ID |
| 135 | * @return Builder by setting SRP ID |
| 136 | */ |
| 137 | Builder setSrpID(int srpID); |
| 138 | |
| 139 | /** |
| 140 | * Returns R flag of SRP Object. |
| 141 | * |
| 142 | * @return R flag of SRP Object |
| 143 | */ |
| 144 | boolean getRFlag(); |
| 145 | |
| 146 | /** |
Avantika-Huawei | 7c14e66 | 2016-05-16 19:13:34 +0530 | [diff] [blame] | 147 | * Returns S(sync) flag of SRP Object. |
| 148 | * |
| 149 | * @return S flag of SRP Object |
| 150 | */ |
| 151 | boolean getSFlag(); |
| 152 | |
| 153 | /** |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 154 | * Sets R flag and returns its builder. |
| 155 | * |
| 156 | * @param bRFlag R flag |
| 157 | * @return Builder by setting R flag |
| 158 | */ |
| 159 | Builder setRFlag(boolean bRFlag); |
| 160 | |
| 161 | /** |
Avantika-Huawei | 7c14e66 | 2016-05-16 19:13:34 +0530 | [diff] [blame] | 162 | * Sets S flag and returns its builder. |
| 163 | * |
| 164 | * @param bSFlag S flag |
| 165 | * @return Builder by setting S flag |
| 166 | */ |
| 167 | Builder setSFlag(boolean bSFlag); |
| 168 | |
| 169 | /** |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 170 | * Returns list of optional tlvs. |
| 171 | * |
| 172 | * @return llOptionalTlv list of optional tlvs |
| 173 | */ |
Sho SHIMIZU | 260f6ef | 2015-08-11 13:53:31 -0700 | [diff] [blame] | 174 | LinkedList<PcepValueType> getOptionalTlv(); |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 175 | |
| 176 | /** |
| 177 | * sets the optional TLvs. |
| 178 | * |
| 179 | * @param llOptionalTlv List of optional tlv |
| 180 | * @return builder by setting list of optional tlv. |
| 181 | */ |
Sho SHIMIZU | 260f6ef | 2015-08-11 13:53:31 -0700 | [diff] [blame] | 182 | Builder setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv); |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 183 | |
| 184 | /** |
| 185 | * Sets P flag in SRP object header and returns its builder. |
| 186 | * |
| 187 | * @param value boolean value to set P flag |
| 188 | * @return Builder by setting P flag |
| 189 | */ |
| 190 | Builder setPFlag(boolean value); |
| 191 | |
| 192 | /** |
| 193 | * Sets I flag in SRP object header and returns its builder. |
| 194 | * |
| 195 | * @param value boolean value to set I flag |
| 196 | * @return Builder by setting I flag |
| 197 | */ |
| 198 | Builder setIFlag(boolean value); |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 199 | } |
| 200 | } |