Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.sdnip; |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 17 | |
| 18 | import java.util.Collection; |
| 19 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.sdnip.bgp.BgpRouteEntry; |
| 21 | import org.onosproject.sdnip.bgp.BgpSession; |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Service interface exported by SDN-IP. |
| 25 | */ |
| 26 | public interface SdnIpService { |
| 27 | /** |
Pavlin Radoslavov | 0c84da8 | 2014-11-07 17:53:34 -0800 | [diff] [blame] | 28 | * Gets the BGP sessions. |
| 29 | * |
| 30 | * @return the BGP sessions |
| 31 | */ |
| 32 | public Collection<BgpSession> getBgpSessions(); |
| 33 | |
| 34 | /** |
Pavlin Radoslavov | 3a0a52e | 2015-01-06 17:41:37 -0800 | [diff] [blame^] | 35 | * Gets the selected IPv4 BGP routes among all BGP sessions. |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 36 | * |
Pavlin Radoslavov | 3a0a52e | 2015-01-06 17:41:37 -0800 | [diff] [blame^] | 37 | * @return the selected IPv4 BGP routes among all BGP sessions |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 38 | */ |
Pavlin Radoslavov | 3a0a52e | 2015-01-06 17:41:37 -0800 | [diff] [blame^] | 39 | public Collection<BgpRouteEntry> getBgpRoutes4(); |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 40 | |
| 41 | /** |
Pavlin Radoslavov | 3a0a52e | 2015-01-06 17:41:37 -0800 | [diff] [blame^] | 42 | * Gets the selected IPv6 BGP routes among all BGP sessions. |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 43 | * |
Pavlin Radoslavov | 3a0a52e | 2015-01-06 17:41:37 -0800 | [diff] [blame^] | 44 | * @return the selected IPv6 BGP routes among all BGP sessions |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 45 | */ |
Pavlin Radoslavov | 3a0a52e | 2015-01-06 17:41:37 -0800 | [diff] [blame^] | 46 | public Collection<BgpRouteEntry> getBgpRoutes6(); |
| 47 | |
| 48 | /** |
| 49 | * Gets all IPv4 routes known to SDN-IP. |
| 50 | * |
| 51 | * @return the SDN-IP IPv4 routes |
| 52 | */ |
| 53 | public Collection<RouteEntry> getRoutes4(); |
| 54 | |
| 55 | /** |
| 56 | * Gets all IPv6 routes known to SDN-IP. |
| 57 | * |
| 58 | * @return the SDN-IP IPv6 routes |
| 59 | */ |
| 60 | public Collection<RouteEntry> getRoutes6(); |
Jonathan Hart | ec2df01 | 2014-10-23 16:40:24 -0700 | [diff] [blame] | 61 | |
| 62 | /** |
| 63 | * Changes whether this SDN-IP instance is the primary or not based on the |
| 64 | * boolean parameter. |
| 65 | * |
| 66 | * @param isPrimary true if the instance is primary, false if it is not |
| 67 | */ |
| 68 | public void modifyPrimary(boolean isPrimary); |
Jonathan Hart | 0b04bed | 2014-10-16 16:39:19 -0700 | [diff] [blame] | 69 | } |