wei wei | 89ddc32 | 2015-03-22 16:29:04 -0500 | [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.tunnel; |
| 17 | |
| 18 | import org.onosproject.net.ConnectPoint; |
| 19 | import org.onosproject.net.DeviceId; |
| 20 | import org.onosproject.net.Path; |
| 21 | |
| 22 | /** |
| 23 | * Service for administering the inventory of provisioned tunnels. |
| 24 | */ |
| 25 | public interface TunnelAdminService { |
| 26 | |
| 27 | /** |
| 28 | * Removes the provisioned tunnel. |
| 29 | * |
| 30 | * @param tunnelId tunnel ID |
| 31 | */ |
| 32 | void removeTunnel(TunnelId tunnelId); |
| 33 | |
| 34 | /** |
| 35 | * Removes the provisioned tunnel leading to and from the |
| 36 | * specified labels. |
| 37 | * |
| 38 | * @param src source label |
| 39 | * @param dst destination label |
| 40 | */ |
| 41 | void removeTunnels(Label src, Label dst); |
| 42 | |
| 43 | /** |
| 44 | * Removes all provisioned tunnels leading to and from the |
| 45 | * specified connection point. |
| 46 | * |
| 47 | * @param src source connection point |
| 48 | * @param dst destination connection point |
| 49 | */ |
| 50 | void removeTunnels(ConnectPoint src, ConnectPoint dst); |
| 51 | |
| 52 | /** |
| 53 | * Removes all provisioned tunnels leading to and from the |
| 54 | * specified connection point. |
| 55 | * |
| 56 | * @param src source connection point |
| 57 | * @param dst destination connection point |
| 58 | * @param type tunnel type |
| 59 | */ |
| 60 | void removeTunnels(ConnectPoint src, ConnectPoint dst, Tunnel.Type type); |
| 61 | |
| 62 | /** |
| 63 | * Removes all provisioned tunnels leading to and from the |
| 64 | * specified connection point. |
| 65 | * |
| 66 | * @param connectPoint connection point |
| 67 | */ |
| 68 | void removeTunnels(ConnectPoint connectPoint); |
| 69 | |
| 70 | /** |
| 71 | * Removes all provisioned tunnels leading to and from the |
| 72 | * specified device. |
| 73 | * |
| 74 | * @param deviceId device identifier |
| 75 | */ |
| 76 | void removeTunnels(DeviceId deviceId); |
| 77 | |
| 78 | /** |
| 79 | * Invokes the core to update a tunnel based on specified tunnel parameters. |
| 80 | * |
| 81 | * @param tunnel Tunnel |
| 82 | * @param path explicit route (path changed) or null (path not changed) for the tunnel |
| 83 | */ |
| 84 | void updateTunnel(Tunnel tunnel, Path path); |
| 85 | |
| 86 | } |