CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [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 | package org.onosproject.net.behaviour; |
| 17 | |
| 18 | import java.util.Collection; |
| 19 | import java.util.List; |
| 20 | import java.util.Set; |
| 21 | |
| 22 | import org.onosproject.net.PortNumber; |
| 23 | import org.onosproject.net.device.PortDescription; |
| 24 | import org.onosproject.net.driver.HandlerBehaviour; |
| 25 | |
| 26 | /** |
| 27 | * Behaviour for handling various drivers for bridge configurations. |
| 28 | */ |
| 29 | public interface BridgeConfig extends HandlerBehaviour { |
| 30 | |
| 31 | /** |
| 32 | * Add a bridge. |
| 33 | * |
| 34 | * @param bridgeName bridge name |
| 35 | */ |
| 36 | void addBridge(BridgeName bridgeName); |
| 37 | |
| 38 | /** |
lishuai | 6c56f5e | 2015-11-17 16:38:19 +0800 | [diff] [blame] | 39 | * Adds a bridge with given bridge name, dpid and exPortName. |
| 40 | * |
| 41 | * @param bridgeName bridge name |
| 42 | * @param dpid dpid |
| 43 | * @param exPortName external port name |
| 44 | */ |
| 45 | void addBridge(BridgeName bridgeName, String dpid, String exPortName); |
| 46 | |
| 47 | /** |
Hyunsun Moon | aab8c67 | 2015-10-27 19:42:12 -0700 | [diff] [blame] | 48 | * Adds a bridge with given bridge name and dpid, and sets the controller |
| 49 | * of the bridge with given controllers. |
| 50 | * |
| 51 | * @param bridgeName bridge name |
| 52 | * @param dpid dpid |
| 53 | * @param controllers list of controller |
| 54 | * @return true if succeeds, fail otherwise |
| 55 | */ |
| 56 | boolean addBridge(BridgeName bridgeName, String dpid, List<ControllerInfo> controllers); |
| 57 | |
| 58 | /** |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 59 | * Remove a bridge. |
| 60 | * |
| 61 | * @param bridgeName bridge name |
| 62 | */ |
| 63 | void deleteBridge(BridgeName bridgeName); |
| 64 | |
| 65 | /** |
| 66 | * Remove a bridge. |
| 67 | * |
| 68 | * @return bridge collection |
| 69 | */ |
| 70 | Collection<BridgeDescription> getBridges(); |
| 71 | |
| 72 | /** |
| 73 | * Add a logical/virtual port. |
Andrea Campanella | 65ece15 | 2016-01-21 13:33:43 -0800 | [diff] [blame] | 74 | * @deprecated version 1.5.0 - Falcon. |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 75 | * |
| 76 | * @param port port number |
| 77 | */ |
Hyunsun Moon | 52b9336 | 2016-01-19 11:53:57 -0800 | [diff] [blame] | 78 | @Deprecated |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 79 | void addPort(PortDescription port); |
| 80 | |
| 81 | /** |
Hyunsun Moon | 52b9336 | 2016-01-19 11:53:57 -0800 | [diff] [blame] | 82 | * Adds a port to a given bridge. |
| 83 | * |
| 84 | * @param bridgeName bridge name |
| 85 | * @param portName port name |
| 86 | */ |
| 87 | void addPort(BridgeName bridgeName, String portName); |
| 88 | |
| 89 | /** |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 90 | * Delete a logical/virtual port. |
Andrea Campanella | 65ece15 | 2016-01-21 13:33:43 -0800 | [diff] [blame] | 91 | * @deprecated version 1.5.0 - Falcon. |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 92 | * |
| 93 | * @param port port number |
| 94 | */ |
Andrea Campanella | 65ece15 | 2016-01-21 13:33:43 -0800 | [diff] [blame] | 95 | @Deprecated |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 96 | void deletePort(PortDescription port); |
| 97 | |
| 98 | /** |
Andrea Campanella | 65ece15 | 2016-01-21 13:33:43 -0800 | [diff] [blame] | 99 | * Removes a port from a given bridge. |
| 100 | * |
| 101 | * @param bridgeName bridge name |
| 102 | * @param portName port name |
| 103 | */ |
| 104 | void deletePort(BridgeName bridgeName, String portName); |
| 105 | |
| 106 | /** |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 107 | * Delete a logical/virtual port. |
| 108 | * |
| 109 | * @return collection of port |
| 110 | */ |
| 111 | Collection<PortDescription> getPorts(); |
| 112 | |
| 113 | /** |
| 114 | * Get a collection of port. |
| 115 | * |
| 116 | * @return portNumbers set of PortNumber |
| 117 | */ |
| 118 | Set<PortNumber> getPortNumbers(); |
| 119 | |
| 120 | /** |
| 121 | * Get logical/virtual ports by ifaceIds. |
| 122 | * |
| 123 | * @param ifaceIds the ifaceid that needed |
| 124 | * @return list of PortNumber |
| 125 | */ |
| 126 | List<PortNumber> getLocalPorts(Iterable<String> ifaceIds); |
| 127 | } |