| 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 | /**
|
| 23 | * Abstraction of an entity providing PCEP Update Request List.
|
| 24 | */
|
| 25 | public interface PcepUpdateRequest {
|
| 26 |
|
| 27 | /**
|
| 28 | * Returns object of PCEP SRP Object.
|
| 29 | *
|
| 30 | * @return srpObject of type PCEP SRP Object
|
| 31 | */
|
| 32 | PcepSrpObject getSrpObject();
|
| 33 |
|
| 34 | /**
|
| 35 | * Returns object of PCEP LSP Object.
|
| 36 | *
|
| 37 | * @return lspObject of type PCEP LSP Object
|
| 38 | */
|
| 39 | PcepLspObject getLspObject();
|
| 40 |
|
| 41 | /**
|
| 42 | * Returns object of PCEP MSG PATH.
|
| 43 | *
|
| 44 | * @return msgPath of type PCEP MSG PATH
|
| 45 | */
|
| 46 | PcepMsgPath getMsgPath();
|
| 47 |
|
| 48 | /**
|
| 49 | * Sets the PCEP SRP Object.
|
| 50 | *
|
| 51 | * @param srpObject object of type PCEP SRP Object
|
| 52 | */
|
| 53 | void setSrpObject(PcepSrpObject srpObject);
|
| 54 |
|
| 55 | /**
|
| 56 | * Sets the PCEP LSP Object.
|
| 57 | *
|
| 58 | * @param lspObject object of type PCEP LSP Object
|
| 59 | */
|
| 60 | void setLspObject(PcepLspObject lspObject);
|
| 61 |
|
| 62 | /**
|
| 63 | * sets the PCEP MSG PATH.
|
| 64 | *
|
| 65 | * @param msgPath object of type PCEP MSG PATH
|
| 66 | */
|
| 67 | void setMsgPath(PcepMsgPath msgPath);
|
| 68 |
|
| 69 | /**
|
| 70 | * Prints the attributes of PCEP Update Request.
|
| 71 | */
|
| 72 | public void print();
|
| 73 |
|
| 74 | /**
|
| 75 | * Builder interface with get and set functions to build PcepUpdateRequest.
|
| 76 | */
|
| 77 | public interface Builder {
|
| 78 |
|
| 79 | /**
|
| 80 | * Builds PcepUpdateRequest.
|
| 81 | *
|
| 82 | * @return PcepUpdateRequest
|
| 83 | * @throws PcepParseException if mandatory object is not set
|
| 84 | */
|
| 85 | PcepUpdateRequest build() throws PcepParseException;
|
| 86 |
|
| 87 | /**
|
| 88 | * Returns PcepSrpObject.
|
| 89 | *
|
| 90 | * @return srpObject
|
| 91 | */
|
| 92 | PcepSrpObject getSrpObject();
|
| 93 |
|
| 94 | /**
|
| 95 | * Returns PcepLspObject.
|
| 96 | *
|
| 97 | * @return lspObject
|
| 98 | */
|
| 99 | PcepLspObject getLspObject();
|
| 100 |
|
| 101 | /**
|
| 102 | * Returns PcepMsgPath.
|
| 103 | *
|
| 104 | * @return msgPath
|
| 105 | */
|
| 106 | PcepMsgPath getMsgPath();
|
| 107 |
|
| 108 | /**
|
| 109 | * Sets the SRP Object.
|
| 110 | *
|
| 111 | * @param srpObj of type PcepSrpObject
|
| 112 | * @return builder by setting PcepSrpObject
|
| 113 | */
|
| 114 | Builder setSrpObject(PcepSrpObject srpObj);
|
| 115 |
|
| 116 | /**
|
| 117 | * Sets the LSP Object.
|
| 118 | *
|
| 119 | * @param lspObject of type PcepLspObject
|
| 120 | * @return builder by setting PcepLspObject
|
| 121 | */
|
| 122 | Builder setLspObject(PcepLspObject lspObject);
|
| 123 |
|
| 124 | /**
|
| 125 | * Sets the Path Object.
|
| 126 | *
|
| 127 | * @param msgPath of type PcepMsgPath
|
| 128 | * @return builder by setting PcepMsgPath
|
| 129 | */
|
| 130 | Builder setMsgPath(PcepMsgPath msgPath);
|
| 131 | }
|
| 132 | } |