Henry Yu | 4b4a7eb | 2016-11-09 20:07:53 -0500 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2016 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 | package org.onosproject.tetopology.management.api.node; |
| 17 | |
| 18 | import org.onosproject.tetopology.management.api.EncodingType; |
| 19 | import org.onosproject.tetopology.management.api.SwitchingType; |
| 20 | |
| 21 | import java.util.BitSet; |
| 22 | import java.util.List; |
| 23 | |
| 24 | /** |
| 25 | * Representation of a tunnel termination point. |
| 26 | */ |
| 27 | public interface TunnelTerminationPoint { |
| 28 | /** |
| 29 | * Indicates that the TTP supports one-plus-one protection. |
| 30 | */ |
| 31 | public static final short BIT_1PLUS1_PROTECTION_CAPABLE = 0; |
| 32 | |
| 33 | /** |
| 34 | * Indicates that the TTP is disabled. |
| 35 | */ |
| 36 | public static final short BIT_DISABLED = 1; |
| 37 | |
| 38 | /** |
| 39 | * Indicates that the TTP is operationally down. |
| 40 | */ |
| 41 | public static final short BIT_STATUS_DOWN = 2; |
| 42 | |
| 43 | /** |
| 44 | * Returns the tunnel termination point identifier. |
| 45 | * |
| 46 | * @return tunnel termination point id |
| 47 | */ |
| 48 | long ttpId(); |
| 49 | |
| 50 | /** |
| 51 | * Returns the network layer switching type to which this TTP belongs. |
| 52 | * |
| 53 | * @return the switching type |
| 54 | */ |
| 55 | SwitchingType switchingLayer(); |
| 56 | |
| 57 | /** |
| 58 | * Returns the network layer encoding type to which this TTP belongs. |
| 59 | * |
| 60 | * @return the encoding type |
| 61 | */ |
| 62 | EncodingType encodingLayer(); |
| 63 | |
| 64 | /** |
| 65 | * Returns the flags of this TTP. |
| 66 | * |
| 67 | * @return the flags |
| 68 | */ |
| 69 | BitSet flags(); |
| 70 | |
| 71 | /** |
| 72 | * Returns the supported inter-layer locks. |
| 73 | * |
| 74 | * @return list of inter-layer locks |
| 75 | */ |
| 76 | List<Long> interLayerLockList(); |
| 77 | |
| 78 | /** |
| 79 | * Returns the local link connectivity list. |
| 80 | * |
| 81 | * @return the local link connectivity list |
| 82 | */ |
| 83 | List<LocalLinkConnectivity> localLinkConnectivityList(); |
| 84 | |
| 85 | /** |
| 86 | * Returns the remaining adaptation bandwidth at each priority level. |
| 87 | * |
| 88 | * @return list of available adaptation bandwidth |
| 89 | */ |
| 90 | float[] availAdaptBandwidth(); |
| 91 | } |