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

   1 /*
   2  * Copyright (c) 2013, 2015 IBM Corporation and others.  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 import java.util.List;
  12
  13 /**
  14  * This interface defines the methods for CRUD of NB Router objects
  15  *
  16  */
  17
  18 public interface INeutronRouterCRUD
  19     extends INeutronCRUD<NeutronRouter> {
  20     /**
  21      * Applications call this interface method to determine if a particular
  22      * Router object exists
  23      *
  24      * @param uuid
  25      *            UUID of the Router object
  26      * @return boolean
  27      */
  28
  29     boolean routerExists(String uuid);
  30
  31     /**
  32      * Applications call this interface method to return if a particular
  33      * Router object exists
  34      *
  35      * @param uuid
  36      *            UUID of the Router object
  37      * @return {@link org.opendaylight.neutron.spi.NeutronRouter}
  38      *          OpenStack Router class
  39      */
  40
  41     NeutronRouter getRouter(String uuid);
  42
  43     /**
  44      * Applications call this interface method to return all Router objects
  45      *
  46      * @return List of OpenStackRouters objects
  47      */
  48
  49     List<NeutronRouter> getAllRouters();
  50
  51     /**
  52      * Applications call this interface method to add a Router object to the
  53      * concurrent map
  54      *
  55      * @param input
  56      *            OpenStackRouter object
  57      * @return boolean on whether the object was added or not
  58      */
  59
  60     boolean addRouter(NeutronRouter input);
  61
  62     /**
  63      * Applications call this interface method to remove a Router object to the
  64      * concurrent map
  65      *
  66      * @param uuid
  67      *            identifier for the Router object
  68      * @return boolean on whether the object was removed or not
  69      */
  70
  71     boolean removeRouter(String uuid);
  72
  73     /**
  74      * Applications call this interface method to edit a Router object
  75      *
  76      * @param uuid
  77      *            identifier of the Router object
  78      * @param delta
  79      *            OpenStackRouter object containing changes to apply
  80      * @return boolean on whether the object was updated or not
  81      */
  82
  83     boolean updateRouter(String uuid, NeutronRouter delta);
  84
  85     /**
  86      * Applications call this interface method to check if a router is in use
  87      *
  88      * @param routerUUID
  89      *            identifier of the Router object
  90      * @return boolean on whether the router is in use or not
  91      */
  92
  93     boolean routerInUse(String routerUUID);
  94 }