neutron-spi/src/main/java/org/opendaylight/neutron/spi/INeutronLoadBalancerPoolCRUD.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 import java.util.List;
  12
  13 /**
  14  * This interface defines the methods for CRUD of NB OpenStack LoadBalancerPool objects
  15  *
  16  */
  17
  18 public interface INeutronLoadBalancerPoolCRUD extends INeutronCRUD<NeutronLoadBalancerPool> {
  19     /**
  20      * Applications call this interface method to determine if a particular
  21      *NeutronLoadBalancerPoolMember object exists
  22      *
  23      * @param poolUuid
  24      *            UUID of the NeutronLoadBalancerPool object
  25      * @param uuid
  26      *            UUID of the NeutronLoadBalancerPoolMember object
  27      * @return boolean
  28      */
  29
  30     boolean neutronLoadBalancerPoolMemberExists(String poolUuid, String uuid);
  31
  32     /**
  33      * Applications call this interface method to return if a particular
  34      * NeutronLoadBalancerPoolMember object exists
  35      *
  36      * @param poolUuid
  37      *            UUID of the NeutronLoadBalancerPool object
  38      * @param uuid
  39      *            UUID of the NeutronLoadBalancerPoolMember object
  40      * @return {@link org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember}
  41      *          OpenStackNeutronLoadBalancerPoolMember class
  42      */
  43
  44     NeutronLoadBalancerPoolMember getNeutronLoadBalancerPoolMember(String poolUuid, String uuid);
  45
  46     /**
  47      * Applications call this interface method to return all NeutronLoadBalancerPoolMember objects
  48      *
  49      * @param poolUuid
  50      *            UUID of the NeutronLoadBalancerPool object
  51      * @return List of OpenStackNetworks objects
  52      */
  53
  54     List<NeutronLoadBalancerPoolMember> getAllNeutronLoadBalancerPoolMembers(String poolUuid);
  55
  56     /**
  57      * Applications call this interface method to add a NeutronLoadBalancerPoolMember object to the
  58      * concurrent map
  59      *
  60      * @param poolUuid
  61      *            UUID of the NeutronLoadBalancerPool object
  62      * @param input
  63      *            OpenStackNetwork object
  64      * @return boolean on whether the object was added or not
  65      */
  66
  67     boolean addNeutronLoadBalancerPoolMember(String poolUuid, NeutronLoadBalancerPoolMember input);
  68
  69     /**
  70      * Applications call this interface method to remove a Neutron NeutronLoadBalancerPoolMember object to the
  71      * concurrent map
  72      *
  73      * @param poolUuid
  74      *            UUID of the NeutronLoadBalancerPool object
  75      * @param uuid
  76      *            identifier for the NeutronLoadBalancerPoolMember object
  77      * @return boolean on whether the object was removed or not
  78      */
  79
  80     boolean removeNeutronLoadBalancerPoolMember(String poolUuid, String uuid);
  81
  82     /**
  83      * Applications call this interface method to edit a NeutronLoadBalancerPoolMember object
  84      *
  85      * @param poolUuid
  86      *            identifier of the NeutronLoadBalancerPool object
  87      * @param uuid
  88      *            identifier of the NeutronLoadBalancerPoolMember object
  89      * @param delta
  90      *            OpenStackNeutronLoadBalancerPoolMember object containing changes to apply
  91      * @return boolean on whether the object was updated or not
  92      */
  93
  94     boolean updateNeutronLoadBalancerPoolMember(String poolUuid, String uuid, NeutronLoadBalancerPoolMember delta);
  95
  96     /**
  97      * Applications call this interface method to see if a MAC address is in use
  98      *
  99      * @param poolUuid
 100      *            identifier of the NeutronLoadBalancerPool object
 101      * @param uuid
 102      *            identifier of the NeutronLoadBalancerPoolMember object
 103      * @return boolean on whether the macAddress is already associated with a
 104      *             port or not
 105      */
 106
 107     boolean neutronLoadBalancerPoolMemberInUse(String poolUuid, String uuid);
 108 }