Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame^] | 1 | /*
|
| 2 | * Copyright 2015 Open Networking Laboratory
|
| 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 org.onosproject.pcepio.exceptions.PcepParseException;
|
| 20 |
|
| 21 | /**
|
| 22 | * Abstraction of an entity Provides PcInitiatedLspRequest for PCEP Initiate message.
|
| 23 | * Reference : PCE initiated tunnel setup draft-ietf-pce-pce-initiated-lsp-03.
|
| 24 | */
|
| 25 | public interface PcInitiatedLspRequest {
|
| 26 |
|
| 27 | /**
|
| 28 | * Returns object of PcepSrpObject.
|
| 29 | *
|
| 30 | * @return srpObject PCEP SRP object
|
| 31 | */
|
| 32 | PcepSrpObject getSrpObject();
|
| 33 |
|
| 34 | /**
|
| 35 | * Returns object of PcepLspObject.
|
| 36 | *
|
| 37 | * @return lspObject PCEP LSP object
|
| 38 | */
|
| 39 | PcepLspObject getLspObject();
|
| 40 |
|
| 41 | /**
|
| 42 | * Returns object of PcepEndPointsObject.
|
| 43 | *
|
| 44 | * @return endPointsObject PCEP EndPoints object
|
| 45 | */
|
| 46 | PcepEndPointsObject getEndPointsObject();
|
| 47 |
|
| 48 | /**
|
| 49 | * Returns object of PcepEroObject.
|
| 50 | *
|
| 51 | * @return eroObject PCEP ERO object
|
| 52 | */
|
| 53 | PcepEroObject getEroObject();
|
| 54 |
|
| 55 | /**
|
| 56 | * Returns object of PcepAttribute.
|
| 57 | *
|
| 58 | * @return pcepAttribute PCEP Attributes
|
| 59 | */
|
| 60 | PcepAttribute getPcepAttribute();
|
| 61 |
|
| 62 | /**
|
| 63 | * Sets PcepSrpObject.
|
| 64 | *
|
| 65 | * @param srpobj PCEP SRP object
|
| 66 | */
|
| 67 | void setSrpObject(PcepSrpObject srpobj);
|
| 68 |
|
| 69 | /**
|
| 70 | * Sets PcepLspObject.
|
| 71 | *
|
| 72 | * @param lspObject PCEP LSP object
|
| 73 | */
|
| 74 | void setLspObject(PcepLspObject lspObject);
|
| 75 |
|
| 76 | /**
|
| 77 | * Sets PcepEndPointsObject.
|
| 78 | *
|
| 79 | * @param endPointsObject PCEP EndPoints object
|
| 80 | */
|
| 81 | void setEndPointsObject(PcepEndPointsObject endPointsObject);
|
| 82 |
|
| 83 | /**
|
| 84 | * Sets PcepEroObject.
|
| 85 | *
|
| 86 | * @param eroObject PCEP ERO object
|
| 87 | */
|
| 88 | void setEroObject(PcepEroObject eroObject);
|
| 89 |
|
| 90 | /**
|
| 91 | * Sets PcepAttribute.
|
| 92 | *
|
| 93 | * @param pcepAttribute PCEP Attributes
|
| 94 | */
|
| 95 | void setPcepAttribute(PcepAttribute pcepAttribute);
|
| 96 |
|
| 97 | /**
|
| 98 | * Prints the attribute of PC-INITIATED LSP INITIATION REQUEST.
|
| 99 | */
|
| 100 | void print();
|
| 101 |
|
| 102 | /**
|
| 103 | * Builder interface with get and set functions to build PcInitiatedLspRequest.
|
| 104 | */
|
| 105 | public interface Builder {
|
| 106 |
|
| 107 | /**
|
| 108 | * Builds PcInitiatedLspRequest.
|
| 109 | *
|
| 110 | * @return PcInitiatedLspRequest
|
| 111 | * @throws PcepParseException when mandatory object is not set
|
| 112 | */
|
| 113 | PcInitiatedLspRequest build() throws PcepParseException;
|
| 114 |
|
| 115 | /**
|
| 116 | * Returns object of PcepSrpObject.
|
| 117 | *
|
| 118 | * @return srpObject
|
| 119 | */
|
| 120 | PcepSrpObject getSrpObject();
|
| 121 |
|
| 122 | /**
|
| 123 | * Returns object of PcepLspObject.
|
| 124 | *
|
| 125 | * @return lspObject
|
| 126 | */
|
| 127 | PcepLspObject getLspObject();
|
| 128 |
|
| 129 | /**
|
| 130 | * Returns object of PcepEndPointsObject.
|
| 131 | *
|
| 132 | * @return endPointsObject
|
| 133 | */
|
| 134 | PcepEndPointsObject getEndPointsObject();
|
| 135 |
|
| 136 | /**
|
| 137 | * Returns object of PcepEroObject.
|
| 138 | *
|
| 139 | * @return eroObject
|
| 140 | */
|
| 141 | PcepEroObject getEroObject();
|
| 142 |
|
| 143 | /**
|
| 144 | * Returns object of PcepAttribute.
|
| 145 | *
|
| 146 | * @return pcepAttribute
|
| 147 | */
|
| 148 | PcepAttribute getPcepAttribute();
|
| 149 |
|
| 150 | /**
|
| 151 | * Sets PcepSrpObject.
|
| 152 | *
|
| 153 | * @param srpobj PCEP SRP Object
|
| 154 | * @return builder by setting PcepSrpObject
|
| 155 | */
|
| 156 | Builder setSrpObject(PcepSrpObject srpobj);
|
| 157 |
|
| 158 | /**
|
| 159 | * Sets PcepLspObject.
|
| 160 | *
|
| 161 | * @param lspObject PCEP LSP Object
|
| 162 | * @return builder by setting PcepLspObject
|
| 163 | */
|
| 164 | Builder setLspObject(PcepLspObject lspObject);
|
| 165 |
|
| 166 | /**
|
| 167 | * Sets PcepEndPointsObject.
|
| 168 | *
|
| 169 | * @param endPointsObject EndPoints Object
|
| 170 | * @return builder by setting PcepEndPointsObject
|
| 171 | */
|
| 172 | Builder setEndPointsObject(PcepEndPointsObject endPointsObject);
|
| 173 |
|
| 174 | /**
|
| 175 | * Sets PcepEroObject.
|
| 176 | *
|
| 177 | * @param eroObject PCEP ERO Object
|
| 178 | * @return builder by setting PcepEroObject
|
| 179 | */
|
| 180 | Builder setEroObject(PcepEroObject eroObject);
|
| 181 |
|
| 182 | /**
|
| 183 | * Sets PcepAttribute.
|
| 184 | *
|
| 185 | * @param pcepAttribute PCEP Attributes
|
| 186 | * @return builder by setting PcepAttribute
|
| 187 | */
|
| 188 | Builder setPcepAttribute(PcepAttribute pcepAttribute);
|
| 189 | }
|
| 190 | }
|