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

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