Pingping Lin | ffa27d3 | 2015-04-30 14:41:03 -0700 | [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.virtualbng; |
| 17 | |
| 18 | import org.onlab.packet.IpAddress; |
Pingping Lin | be12656 | 2015-05-06 17:57:10 -0700 | [diff] [blame^] | 19 | import org.onlab.packet.MacAddress; |
Pingping Lin | ffa27d3 | 2015-04-30 14:41:03 -0700 | [diff] [blame] | 20 | |
| 21 | /** |
| 22 | * Provides information about the virtual BNG configuration. |
| 23 | */ |
| 24 | public interface VbngConfigurationService { |
| 25 | |
| 26 | /** |
| 27 | * Gets the IP address configured for the next hop. |
| 28 | * |
| 29 | * @return the IP address of next hop |
| 30 | */ |
| 31 | public IpAddress getNextHopIpAddress(); |
| 32 | |
| 33 | /** |
Pingping Lin | be12656 | 2015-05-06 17:57:10 -0700 | [diff] [blame^] | 34 | * Gets the MAC address configured for all the public IP addresses. |
| 35 | * |
| 36 | * @return the MAC address |
| 37 | */ |
| 38 | public MacAddress getPublicFacingMac(); |
| 39 | |
| 40 | /** |
| 41 | * Evaluates whether an IP address is an assigned public IP address. |
| 42 | * |
| 43 | * @param ipAddress the IP address to evaluate |
| 44 | * @return true if the input IP address is an assigned public IP address, |
| 45 | * otherwise false |
| 46 | */ |
| 47 | public boolean isAssignedPublicIpAddress(IpAddress ipAddress); |
| 48 | |
| 49 | /** |
Pingping Lin | ffa27d3 | 2015-04-30 14:41:03 -0700 | [diff] [blame] | 50 | * Gets an available public IP address from local public IP prefixes. |
| 51 | * |
| 52 | * @param privateIpAddress a private IP address |
| 53 | * @return an available public IP address if it exists, otherwise null |
| 54 | */ |
| 55 | public IpAddress getAvailablePublicIpAddress(IpAddress privateIpAddress); |
Pingping Lin | 4e0c73d | 2015-05-06 15:41:10 -0700 | [diff] [blame] | 56 | |
| 57 | /** |
| 58 | * Gets the public IP address already assigned for a private IP address. |
| 59 | * |
| 60 | * @param privateIpAddress a private IP address |
| 61 | * @return the assigned public IP address if it exists, otherwise null |
| 62 | */ |
| 63 | public IpAddress getAssignedPublicIpAddress(IpAddress privateIpAddress); |
Pingping Lin | ffa27d3 | 2015-04-30 14:41:03 -0700 | [diff] [blame] | 64 | } |