2 * Copyright (C) 2018 Bell Canada.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org.onap.ccsdk.sli.adaptors.netbox.impl;
18 import com.google.common.collect.Lists;
19 import com.google.gson.JsonSyntaxException;
20 import java.io.IOException;
21 import java.sql.SQLException;
22 import java.util.ArrayList;
24 import javax.sql.rowset.CachedRowSet;
25 import org.apache.http.HttpResponse;
26 import org.apache.http.util.EntityUtils;
27 import org.onap.ccsdk.sli.adaptors.netbox.api.NetboxClient;
28 import org.onap.ccsdk.sli.adaptors.netbox.model.IPAddress;
29 import org.onap.ccsdk.sli.adaptors.netbox.model.IPStatus;
30 import org.onap.ccsdk.sli.core.dblib.DbLibService;
31 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
32 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
33 import org.onap.ccsdk.sli.core.sli.SvcLogicResource.QueryStatus;
34 import org.onap.ccsdk.sli.core.slipluginutils.SliPluginUtils;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
38 public class NetboxClientImpl implements NetboxClient {
40 private static final Logger LOG = LoggerFactory.getLogger(NetboxClientImpl.class);
44 private static final String NEXT_AVAILABLE_IP_IN_PREFIX_PATH = "/api/ipam/prefixes/%s/available-ips/";
45 private static final String IP_ADDRESS_PATH = "/api/ipam/ip-addresses/%s/";
49 private static final String ASSIGN_IP_ADDRESS_PAYLOAD = "{\n"
50 + " \"custom_fields\": {\n"
51 + " \"external-key\": \"%s\",\n"
52 + " \"resource-name\": \"%s\"\n"
56 // Service Logic Context input variables and exception
58 private static final String SERVICE_INSTANCE_ID_PROP = "service_instance_id";
59 private static final String VF_MODULE_ID_PROP = "vf_module_id";
60 private static final String EXTERNAL_KEY_PROP = "external_key";
61 private static final String SQL_EXCEPTION_MESSAGE = "Caught SQL exception";
65 private static final String ASSIGN_IP_SQL_STATEMENT =
66 "INSERT INTO IPAM_IP_ASSIGNEMENT (service_instance_id, vf_module_id, prefix_id, ip_address_id, ip_address, ip_status, ip_response_json, external_key) \n"
67 + "VALUES (?, ?, ?, ?, ?, ?, ?)";
68 private static final String UNASSIGN_IP_SQL_STATEMENT =
69 "UPDATE IPAM_IP_ASSIGNEMENT SET ip_status = ? WHERE service_instance_id = ? AND external_key = ?";
70 private static final String GET_IP_ADDRESS_ID_SQL_STATEMENT =
71 "SELECT ip_address_id FROM IPAM_IP_ASSIGNEMENT WHERE service_instance_id = ? AND external_key = ?";
73 private final NetboxHttpClient client;
74 private final DbLibService dbLibService;
76 public NetboxClientImpl(final NetboxHttpClient client, final DbLibService dbLibService) {
78 this.dbLibService = dbLibService;
82 public QueryStatus assignIpAddress(final Map<String, String> parameters, final SvcLogicContext ctx) {
86 .checkParameters(parameters,
87 new String[]{SERVICE_INSTANCE_ID_PROP, VF_MODULE_ID_PROP, "prefix_id", "resource_name",
88 EXTERNAL_KEY_PROP}, LOG);
89 } catch (SvcLogicException e) {
90 return QueryStatus.FAILURE;
93 final String serviceInstanceId = parameters.get(SERVICE_INSTANCE_ID_PROP);
94 final String vfModuleId = parameters.get(VF_MODULE_ID_PROP);
95 final String prefixId = parameters.get("prefix_id");
96 final String resourceName = parameters.get("resource_name");
97 final String externalKey = parameters.get(EXTERNAL_KEY_PROP);
99 HttpResponse httpResp;
102 .post(String.format(NEXT_AVAILABLE_IP_IN_PREFIX_PATH, prefixId),
103 String.format(ASSIGN_IP_ADDRESS_PAYLOAD, externalKey, resourceName));
104 } catch (IOException e) {
105 LOG.error("Fail to assign IP for Prefix(id={}). {}", prefixId, e.getMessage(), e.getCause());
106 return QueryStatus.FAILURE;
111 ipamRespJson = EntityUtils.toString(httpResp.getEntity(), "UTF-8");
112 } catch (IOException e) {
113 LOG.error("Fail to parse IPAM response for assign in Prefix(id={}). Response={}", prefixId,
114 httpResp.getEntity(), e);
115 return QueryStatus.FAILURE;
118 if (httpResp.getStatusLine().getStatusCode() != 201) {
119 LOG.error("Fail to assign IP for Prefix(id={}). HTTP code 201!={}. Response={}", prefixId,
120 httpResp.getStatusLine().getStatusCode(), ipamRespJson);
121 return QueryStatus.FAILURE;
126 ipAddress = IPAddress.fromJson(ipamRespJson);
127 } catch (JsonSyntaxException e) {
128 LOG.error("Fail to parse IPAM JSON reponse to IPAddress POJO. IPAM JSON Response={}", ipamRespJson, e);
129 return QueryStatus.FAILURE;
132 ArrayList<String> args = Lists.newArrayList(
135 String.valueOf(prefixId),
136 String.valueOf(ipAddress.getId()),
137 ipAddress.getAddress(),
138 IPStatus.ASSIGNED.name(),
143 dbLibService.writeData(ASSIGN_IP_SQL_STATEMENT, args, null);
144 } catch (SQLException e) {
145 LOG.error(SQL_EXCEPTION_MESSAGE, e);
146 return QueryStatus.FAILURE;
149 ctx.setAttribute("self_serve_netbox_ip_assignement.ip-address", ipAddress.getAddress());
151 return QueryStatus.SUCCESS;
155 public QueryStatus unassignIpAddress(final Map<String, String> parameters, final SvcLogicContext ctx) {
158 .checkParameters(parameters, new String[]{SERVICE_INSTANCE_ID_PROP, EXTERNAL_KEY_PROP},
160 } catch (SvcLogicException e) {
161 return QueryStatus.FAILURE;
164 final String serviceInstanceId = parameters.get(SERVICE_INSTANCE_ID_PROP);
165 final String externalKey = parameters.get(EXTERNAL_KEY_PROP);
168 ArrayList<String> args = Lists.newArrayList(
171 try (CachedRowSet row = dbLibService.getData(GET_IP_ADDRESS_ID_SQL_STATEMENT, args, null)) {
172 ipAddressId = row.getString("ip_address_id");
173 } catch (SQLException e) {
174 LOG.error(SQL_EXCEPTION_MESSAGE, e);
175 return QueryStatus.FAILURE;
178 HttpResponse httpResp;
180 httpResp = client.delete(String.format(IP_ADDRESS_PATH, ipAddressId));
181 } catch (IOException e) {
182 LOG.error("Fail to unassign IP for IPAddress(id= " + ipAddressId + "). " + e.getMessage(),
184 return QueryStatus.FAILURE;
187 if (httpResp.getStatusLine().getStatusCode() - 200 >= 100) {
188 LOG.error("Fail to unassign IP for IPAddress(id={}). HTTP code={}.", ipAddressId,
189 httpResp.getStatusLine().getStatusCode());
190 return QueryStatus.FAILURE;
194 args = Lists.newArrayList(
195 IPStatus.DELETED.name(),
200 dbLibService.writeData(UNASSIGN_IP_SQL_STATEMENT, args, null);
201 } catch (SQLException e) {
202 LOG.error(SQL_EXCEPTION_MESSAGE, e);
203 return QueryStatus.FAILURE;
206 return QueryStatus.SUCCESS;