netbox-client/provider/src/main/java/org/onap/ccsdk/sli/adaptors/netbox/api/NetboxClient.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.api;
  17
  18 import org.onap.ccsdk.sli.adaptors.netbox.model.IPAddress;
  19 import org.onap.ccsdk.sli.adaptors.netbox.model.Prefix;
  20
  21 public interface NetboxClient {
  22
  23     /**
  24      * Assign next available IP in prefix.
  25      *
  26      * @param prefix The prefix from which to get next available IP.
  27      * @return The IPAddress
  28      * @throws IpamException If something goes wrong.
  29      */
  30     IPAddress assign(Prefix prefix) throws IpamException;
  31
  32     /**
  33      * Free the IP.
  34      *
  35      * @param ip The IP to release.
  36      * @throws IpamException If something goes wrong.
  37      */
  38     void unassign(IPAddress ip) throws IpamException;
  39 }
  40