opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronRouterAware.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 Routers needs to implement
  13  *
  14  */
  15
  16 public interface INeutronRouterAware {
  17
  18     /**
  19      * Services provide this interface method to indicate if the specified router can be created
  20      *
  21      * @param router
  22      *            instance of proposed new Neutron Router 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 canCreateRouter(NeutronRouter router);
  29
  30     /**
  31      * Services provide this interface method for taking action after a router has been created
  32      *
  33      * @param router
  34      *            instance of new Neutron Router object
  35      * @return void
  36      */
  37     public void neutronRouterCreated(NeutronRouter router);
  38
  39     /**
  40      * Services provide this interface method to indicate if the specified router can be changed using the specified
  41      * delta
  42      *
  43      * @param delta
  44      *            updates to the router object using patch semantics
  45      * @param router
  46      *            instance of the Neutron Router 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 canUpdateRouter(NeutronRouter delta, NeutronRouter original);
  53
  54     /**
  55      * Services provide this interface method for taking action after a router has been updated
  56      *
  57      * @param router
  58      *            instance of modified Neutron Router object
  59      * @return void
  60      */
  61     public void neutronRouterUpdated(NeutronRouter router);
  62
  63     /**
  64      * Services provide this interface method to indicate if the specified router can be deleted
  65      *
  66      * @param router
  67      *            instance of the Neutron Router 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 canDeleteRouter(NeutronRouter router);
  74
  75     /**
  76      * Services provide this interface method for taking action after a router has been deleted
  77      *
  78      * @param router
  79      *            instance of deleted Router Network object
  80      * @return void
  81      */
  82     public void neutronRouterDeleted(NeutronRouter router);
  83
  84     /**
  85      * Services provide this interface method to indicate if the specified interface can be attached to the specified route
  86      *
  87      * @param router
  88      *            instance of the base Neutron Router object
  89      * @param routerInterface
  90      *            instance of the NeutronRouter_Interface to be attached to the router
  91      * @return integer
  92      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  93      *            results in the attach operation being interrupted and the returned status value reflected in the
  94      *            HTTP response.
  95      */
  96     public int canAttachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface);
  97
  98     /**
  99      * Services provide this interface method for taking action after an interface has been added to a router
 100      *
 101      * @param router
 102      *            instance of the base Neutron Router object
 103      * @param routerInterface
 104      *            instance of the NeutronRouter_Interface being attached to the router
 105      * @return void
 106      */
 107     public void neutronRouterInterfaceAttached(NeutronRouter router, NeutronRouter_Interface routerInterface);
 108
 109     /**
 110      * Services provide this interface method to indicate if the specified interface can be detached from the specified router
 111      *
 112      * @param router
 113      *            instance of the base Neutron Router object
 114      * @param routerInterface
 115      *            instance of the NeutronRouter_Interface to be detached to the router
 116      * @return integer
 117      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
 118      *            results in the detach operation being interrupted and the returned status value reflected in the
 119      *            HTTP response.
 120      */
 121     public int canDetachInterface(NeutronRouter router, NeutronRouter_Interface routerInterface);
 122
 123     /**
 124      * Services provide this interface method for taking action after an interface has been removed from a router
 125      *
 126      * @param router
 127      *            instance of the base Neutron Router object
 128      * @param routerInterface
 129      *            instance of the NeutronRouter_Interface being detached from the router
 130      * @return void
 131      */
 132     public void neutronRouterInterfaceDetached(NeutronRouter router, NeutronRouter_Interface routerInterface);
 133 }