opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronFloatingIPCRUD.java

   1 /*
   2  * Copyright IBM Corporation, 2013.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.networkconfig.neutron;
  10
  11 import java.util.List;
  12
  13 /**
  14  * This interface defines the methods for CRUD of NB FloatingIP objects
  15  *
  16  * @deprecated Replaced by {@link org.opendaylight.neutron.neutron.spi.INeutronFloatingIPCRUD}
  17  */
  18
  19 @Deprecated
  20 public interface INeutronFloatingIPCRUD {
  21     /**
  22      * Applications call this interface method to determine if a particular
  23      * FloatingIP object exists
  24      *
  25      * @param uuid
  26      *            UUID of the FloatingIP object
  27      * @return boolean
  28      */
  29
  30     public boolean floatingIPExists(String uuid);
  31
  32     /**
  33      * Applications call this interface method to return if a particular
  34      * FloatingIP object exists
  35      *
  36      * @param uuid
  37      *            UUID of the FloatingIP object
  38      * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronFloatingIP.OpenStackFloatingIPs}
  39      *          OpenStack FloatingIP class
  40      */
  41
  42     public NeutronFloatingIP getFloatingIP(String uuid);
  43
  44     /**
  45      * Applications call this interface method to return all FloatingIP objects
  46      *
  47      * @return a Set of OpenStackFloatingIPs objects
  48      */
  49
  50     public List<NeutronFloatingIP> getAllFloatingIPs();
  51
  52     /**
  53      * Applications call this interface method to add a FloatingIP object to the
  54      * concurrent map
  55      *
  56      * @param input
  57      *            OpenStackFloatingIP object
  58      * @return boolean on whether the object was added or not
  59      */
  60
  61     public boolean addFloatingIP(NeutronFloatingIP input);
  62
  63     /**
  64      * Applications call this interface method to remove a FloatingIP object to the
  65      * concurrent map
  66      *
  67      * @param uuid
  68      *            identifier for the FloatingIP object
  69      * @return boolean on whether the object was removed or not
  70      */
  71
  72     public boolean removeFloatingIP(String uuid);
  73
  74     /**
  75      * Applications call this interface method to edit a FloatingIP object
  76      *
  77      * @param uuid
  78      *            identifier of the FloatingIP object
  79      * @param delta
  80      *            OpenStackFloatingIP object containing changes to apply
  81      * @return boolean on whether the object was updated or not
  82      */
  83
  84     public boolean updateFloatingIP(String uuid, NeutronFloatingIP delta);
  85 }