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 org.jboss.netty.buffer.ChannelBuffer; |
| 20 | import org.onosproject.pcepio.exceptions.PcepParseException; |
| 21 | |
| 22 | /** |
| 23 | * Abstraction of an entity providing PCEP Messages. |
| 24 | */ |
| 25 | public interface PcepMessage extends PcepObject { |
| 26 | |
| 27 | @Override |
| 28 | PcepVersion getVersion(); |
| 29 | |
| 30 | /** |
| 31 | * Returns Type of PCEP Message. |
| 32 | * |
| 33 | * @return Type of PCEP Message |
| 34 | */ |
| 35 | PcepType getType(); |
| 36 | |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 37 | @Override |
| 38 | void writeTo(ChannelBuffer channelBuffer) throws PcepParseException; |
| 39 | |
| 40 | /** |
| 41 | * Builder interface with get and set functions to build PCEP Message. |
| 42 | */ |
Sho SHIMIZU | 260f6ef | 2015-08-11 13:53:31 -0700 | [diff] [blame] | 43 | interface Builder { |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * Builds PCEP Message. |
| 47 | * |
| 48 | * @return PCEP Message |
| 49 | * @throws PcepParseException when build fails to create PCEP message |
| 50 | */ |
| 51 | PcepMessage build() throws PcepParseException; |
| 52 | |
| 53 | /** |
| 54 | * Returns Version of PCEP Message. |
| 55 | * |
| 56 | * @return Version of PCEP Message |
| 57 | */ |
| 58 | PcepVersion getVersion(); |
| 59 | |
| 60 | /** |
| 61 | * Returns Type of PCEP Message. |
| 62 | * |
| 63 | * @return Type of PCEP Message |
| 64 | */ |
| 65 | PcepType getType(); |
| 66 | } |
| 67 | } |