opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronFloatingIPAware.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 /**
  12  * This interface defines the methods a service that wishes to be aware of Neutron FloatingIPs needs to implement
  13  *
  14  */
  15
  16 public interface INeutronFloatingIPAware {
  17
  18     /**
  19      * Services provide this interface method to indicate if the specified floatingIP can be created
  20      *
  21      * @param floatingIP
  22      *            instance of proposed new Neutron FloatingIP object
  23      * @return integer
  24      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  25      *            results in the create operation being interrupted and the returned status value reflected in the
  26      *            HTTP response.
  27      */
  28     public int canCreateFloatingIP(NeutronFloatingIP floatingIP);
  29
  30     /**
  31      * Services provide this interface method for taking action after a floatingIP has been created
  32      *
  33      * @param floatingIP
  34      *            instance of new Neutron FloatingIP object
  35      * @return void
  36      */
  37     public void neutronFloatingIPCreated(NeutronFloatingIP floatingIP);
  38
  39     /**
  40      * Services provide this interface method to indicate if the specified floatingIP can be changed using the specified
  41      * delta
  42      *
  43      * @param delta
  44      *            updates to the floatingIP object using patch semantics
  45      * @param floatingIP
  46      *            instance of the Neutron FloatingIP object to be updated
  47      * @return integer
  48      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  49      *            results in the update operation being interrupted and the returned status value reflected in the
  50      *            HTTP response.
  51      */
  52     public int canUpdateFloatingIP(NeutronFloatingIP delta, NeutronFloatingIP original);
  53
  54     /**
  55      * Services provide this interface method for taking action after a floatingIP has been updated
  56      *
  57      * @param floatingIP
  58      *            instance of modified Neutron FloatingIP object
  59      * @return void
  60      */
  61     public void neutronFloatingIPUpdated(NeutronFloatingIP floatingIP);
  62
  63     /**
  64      * Services provide this interface method to indicate if the specified floatingIP can be deleted
  65      *
  66      * @param floatingIP
  67      *            instance of the Neutron FloatingIP object to be deleted
  68      * @return integer
  69      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  70      *            results in the delete operation being interrupted and the returned status value reflected in the
  71      *            HTTP response.
  72      */
  73     public int canDeleteFloatingIP(NeutronFloatingIP floatingIP);
  74
  75     /**
  76      * Services provide this interface method for taking action after a floatingIP has been deleted
  77      *
  78      * @param floatingIP
  79      *            instance of deleted Neutron FloatingIP object
  80      * @return void
  81      */
  82     public void neutronFloatingIPDeleted(NeutronFloatingIP floatingIP);
  83 }