neutron-spi/src/main/java/org/opendaylight/neutron/spi/INeutronLoadBalancerAware.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.  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.neutron.spi;
  10
  11 /**
  12  * This interface defines the methods a service that wishes to be aware of LoadBalancer Rules needs to implement
  13  *
  14  */
  15
  16 public interface INeutronLoadBalancerAware {
  17
  18     /**
  19      * Services provide this interface method to indicate if the specified loadBalancer can be created
  20      *
  21      * @param loadBalancer
  22      *            instance of proposed new LoadBalancer 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 canCreateNeutronLoadBalancer(NeutronLoadBalancer loadBalancer);
  29
  30     /**
  31      * Services provide this interface method for taking action after a loadBalancer has been created
  32      *
  33      * @param loadBalancer
  34      *            instance of new LoadBalancer object
  35      */
  36     public void neutronLoadBalancerCreated(NeutronLoadBalancer loadBalancer);
  37
  38     /**
  39      * Services provide this interface method to indicate if the
  40      * specified loadBalancer can be changed using the specified
  41      * delta
  42      *
  43      * @param delta
  44      *            updates to the loadBalancer object using patch semantics
  45      * @param original
  46      *            instance of the LoadBalancer 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 canUpdateNeutronLoadBalancer(NeutronLoadBalancer delta, NeutronLoadBalancer original);
  53
  54     /**
  55      * Services provide this interface method for taking action after a loadBalancer has been updated
  56      *
  57      * @param loadBalancer
  58      *            instance of modified LoadBalancer object
  59      */
  60     public void neutronLoadBalancerUpdated(NeutronLoadBalancer loadBalancer);
  61
  62     /**
  63      * Services provide this interface method to indicate if the specified loadBalancer can be deleted
  64      *
  65      * @param loadBalancer
  66      *            instance of the LoadBalancer object to be deleted
  67      * @return integer
  68      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  69      *            results in the delete operation being interrupted and the returned status value reflected in the
  70      *            HTTP response.
  71      */
  72     public int canDeleteNeutronLoadBalancer(NeutronLoadBalancer loadBalancer);
  73
  74     /**
  75      * Services provide this interface method for taking action after a loadBalancer has been deleted
  76      *
  77      * @param loadBalancer
  78      *            instance of deleted LoadBalancer object
  79      */
  80     public void neutronLoadBalancerDeleted(NeutronLoadBalancer loadBalancer);
  81 }