netbox-client/provider/src/main/java/org/onap/ccsdk/sli/adaptors/netbox/impl/NetboxClientImpl.java

   1 /*
   2  * Copyright (C) 2018 Bell Canada.
   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.onap.ccsdk.sli.adaptors.netbox.impl;
  17
  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;
  23 import java.util.Map;
  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;
  37
  38 public class NetboxClientImpl implements NetboxClient {
  39
  40     private static final Logger LOG = LoggerFactory.getLogger(NetboxClientImpl.class);
  41
  42     // Netbox URI
  43
  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/";
  46
  47     // Netbox Payload
  48
  49     private static final String ASSIGN_IP_ADDRESS_PAYLOAD = "{\n"
  50         + "  \"custom_fields\": {\n"
  51         + "    \"external-key\": \"%s\",\n"
  52         + "    \"resource-name\": \"%s\"\n"
  53         + "  }\n"
  54         + "}";
  55
  56     // Service Logic Context input variables and exception
  57
  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";
  62
  63     // SQL statement
  64
  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, ip_address_type) \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 = ?";
  72
  73     private final NetboxHttpClient client;
  74     private final DbLibService dbLibService;
  75
  76     public NetboxClientImpl(final NetboxHttpClient client, final DbLibService dbLibService) {
  77         this.client = client;
  78         this.dbLibService = dbLibService;
  79     }
  80
  81     @Override
  82     public QueryStatus assignIpAddress(final Map<String, String> parameters, final SvcLogicContext ctx) {
  83
  84         try {
  85             SliPluginUtils
  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;
  91         }
  92
  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);
  98
  99         HttpResponse httpResp;
 100         try {
 101             httpResp = client
 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;
 107         }
 108
 109         String ipamRespJson;
 110         try {
 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;
 116         }
 117
 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;
 122         }
 123
 124         IPAddress ipAddress;
 125         try {
 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;
 130         }
 131
 132         ArrayList<String> args = Lists.newArrayList(
 133             serviceInstanceId,
 134             vfModuleId,
 135             String.valueOf(prefixId),
 136             String.valueOf(ipAddress.getId()),
 137             ipAddress.getAddress(),
 138             IPStatus.ASSIGNED.name(),
 139             ipamRespJson,
 140             externalKey,
 141             resourceName);
 142
 143         try {
 144             dbLibService.writeData(ASSIGN_IP_SQL_STATEMENT, args, null);
 145         } catch (SQLException e) {
 146             LOG.error(SQL_EXCEPTION_MESSAGE, e);
 147             return QueryStatus.FAILURE;
 148         }
 149
 150         ctx.setAttribute("self_serve_netbox_ip_assignement.ip-address", ipAddress.getAddress());
 151
 152         return QueryStatus.SUCCESS;
 153     }
 154
 155     @Override
 156     public QueryStatus unassignIpAddress(final Map<String, String> parameters, final SvcLogicContext ctx) {
 157         try {
 158             SliPluginUtils
 159                 .checkParameters(parameters, new String[]{SERVICE_INSTANCE_ID_PROP, EXTERNAL_KEY_PROP},
 160                     LOG);
 161         } catch (SvcLogicException e) {
 162             return QueryStatus.FAILURE;
 163         }
 164
 165         final String serviceInstanceId = parameters.get(SERVICE_INSTANCE_ID_PROP);
 166         final String externalKey = parameters.get(EXTERNAL_KEY_PROP);
 167
 168         String ipAddressId;
 169         ArrayList<String> args = Lists.newArrayList(
 170             serviceInstanceId,
 171             externalKey);
 172         try (CachedRowSet row = dbLibService.getData(GET_IP_ADDRESS_ID_SQL_STATEMENT, args, null)) {
 173             if (row.next()) {
 174                 ipAddressId = row.getString("ip_address_id");
 175             } else {
 176                 throw new SQLException("Data not found.");
 177             }
 178         } catch (SQLException e) {
 179             LOG.error(SQL_EXCEPTION_MESSAGE, e);
 180             return QueryStatus.FAILURE;
 181         }
 182
 183         HttpResponse httpResp;
 184         try {
 185             httpResp = client.delete(String.format(IP_ADDRESS_PATH, ipAddressId));
 186         } catch (IOException e) {
 187             LOG.error("Fail to unassign IP for IPAddress(id= " + ipAddressId + "). " + e.getMessage(),
 188                 e.getCause());
 189             return QueryStatus.FAILURE;
 190         }
 191
 192         if (httpResp.getStatusLine().getStatusCode() - 200 >= 100) {
 193             LOG.error("Fail to unassign IP for IPAddress(id={}). HTTP code={}.", ipAddressId,
 194                 httpResp.getStatusLine().getStatusCode());
 195             return QueryStatus.FAILURE;
 196         }
 197
 198         args.clear();
 199         args = Lists.newArrayList(
 200             IPStatus.DELETED.name(),
 201             serviceInstanceId,
 202             externalKey);
 203
 204         try {
 205             dbLibService.writeData(UNASSIGN_IP_SQL_STATEMENT, args, null);
 206         } catch (SQLException e) {
 207             LOG.error(SQL_EXCEPTION_MESSAGE, e);
 208             return QueryStatus.FAILURE;
 209         }
 210
 211         return QueryStatus.SUCCESS;
 212     }
 213 }