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
|
/*
* Copyright (C) 2018 Bell Canada.
*
* 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.onap.ccsdk.sli.adaptors.netbox.api;
import java.sql.SQLException;
import org.onap.ccsdk.sli.adaptors.netbox.model.IPAddress;
import org.onap.ccsdk.sli.adaptors.netbox.model.Prefix;
/**
* This client is meant to interact both with the IPAM system, and the SDNC DB, in order to provide, at any time,
* an up to date status of the assigned resources.
*/
public interface NetboxClient {
/**
* Assign next available IP in prefix and store it in the SDNC database, table IPAM_IP_ASSIGNEMENT.
*
* @param prefix The prefix from which to get next available IP.
* @param serviceInstanceId The service instance ID uniquely identifying the service.
* @param vfModuleId The VF module ID uniquely identifying the VF.
* @return The IPAddress
* @throws IpamException If something goes wrong while communicating with the IPAM system.
* @throws SQLException If something goes wrong while communicating with the SDNC DB.
*/
IPAddress assign(Prefix prefix, String serviceInstanceId, String vfModuleId) throws IpamException, SQLException;
/**
* Release the IP and remove the entry in the SDNC database, table IPAM_IP_ASSIGNEMENT.
*
* @param ip The IP to release.
* @param serviceInstanceId The service instance ID uniquely identifying the service.
* @param vfModuleId The VF module ID uniquely identifying the VF.
* @throws IpamException If something goes wrong while communicating with the IPAM system.
* @throws SQLException If something goes wrong while communicating with the SDNC DB.
*/
void unassign(IPAddress ip, String serviceInstanceId, String vfModuleId) throws IpamException, SQLException;
}
|
