blob: e356c38b1e8a7af57b35396b22a92f6a0d8cc921 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.dhcp;
import org.onlab.packet.Ip4Address;
import org.onlab.packet.MacAddress;
import org.onosproject.net.HostId;
import java.util.List;
import java.util.Map;
/**
* DHCP Service Interface.
*/
public interface DhcpService {
/**
* Returns a collection of all the MacAddress to IPAddress mapping.
*
* @return collection of mappings.
*/
Map<HostId, IpAssignment> listMapping();
/**
* Returns the default lease time granted by the DHCP Server.
*
* @return lease time
*/
int getLeaseTime();
/**
* Returns the default renewal time granted by the DHCP Server.
*
* @return renewal time
*/
int getRenewalTime();
/**
* Returns the default rebinding time granted by the DHCP Server.
*
* @return rebinding time
*/
int getRebindingTime();
/**
* Registers a static IP mapping with the DHCP Server.
* Supports the request from OpenStack
*
* @param macID macID of the client
* @param ipAddress IP Address requested for the client
* @param fromOpenStack true if the request is from OpenStack
* @param addressList subnetMask, DHCP/Router/Domain Server IP Address if the request from OpenStack
* @return true if the mapping was successfully added, false otherwise
*/
boolean setStaticMapping(MacAddress macID, Ip4Address ipAddress, boolean fromOpenStack,
List<Ip4Address> addressList);
/**
* Removes a static IP mapping with the DHCP Server.
*
* @param macID macID of the client
* @return true if the mapping was successfully removed, false otherwise
*/
boolean removeStaticMapping(MacAddress macID);
/**
* Returns the list of all the available IPs with the server.
*
* @return list of available IPs
*/
Iterable<Ip4Address> getAvailableIPs();
}
|
