Package org.opendaylight.neutron.spi

Interface INeutronLoadBalancerPoolCRUD

All Superinterfaces:

INeutronCRUD<NeutronLoadBalancerPool>

All Known Implementing Classes:

NeutronLoadBalancerPoolInterface

public interface INeutronLoadBalancerPoolCRUD
extends INeutronCRUD<NeutronLoadBalancerPool>

This interface defines the methods for CRUD of NB OpenStack LoadBalancerPool objects.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.neutron.spi.INeutronCRUD

INeutronCRUD.Result

Method Summary

Modifier and Type	Method	Description
boolean	addNeutronLoadBalancerPoolMember(String poolUuid, NeutronLoadBalancerPoolMember input)	Applications call this interface method to add a NeutronLoadBalancerPoolMember object to the concurrent map.
List<NeutronLoadBalancerPoolMember>	getAllNeutronLoadBalancerPoolMembers(String poolUuid)	Applications call this interface method to return all NeutronLoadBalancerPoolMember objects.
NeutronLoadBalancerPoolMember	getNeutronLoadBalancerPoolMember(String poolUuid, String uuid)	Applications call this interface method to return if a particular NeutronLoadBalancerPoolMember object exists.
boolean	neutronLoadBalancerPoolMemberExists(String poolUuid, String uuid)	Applications call this interface method to determine if a particular NeutronLoadBalancerPoolMember object exists.
boolean	neutronLoadBalancerPoolMemberInUse(String poolUuid, String uuid)	Applications call this interface method to see if a MAC address is in use.
boolean	removeNeutronLoadBalancerPoolMember(String poolUuid, String uuid)	Applications call this interface method to remove a Neutron NeutronLoadBalancerPoolMember object to the concurrent map.
boolean	updateNeutronLoadBalancerPoolMember(String poolUuid, String uuid, NeutronLoadBalancerPoolMember delta)	Applications call this interface method to edit a NeutronLoadBalancerPoolMember object.

Methods inherited from interface org.opendaylight.neutron.spi.INeutronCRUD

add, exists, get, getAll, remove, update

Method Detail

neutronLoadBalancerPoolMemberExists

boolean neutronLoadBalancerPoolMemberExists(String poolUuid,
                                            String uuid)
                                     throws org.opendaylight.mdsal.common.api.ReadFailedException

Applications call this interface method to determine if a particular NeutronLoadBalancerPoolMember object exists.

Parameters:

poolUuid - UUID of the NeutronLoadBalancerPool object

uuid - UUID of the NeutronLoadBalancerPoolMember object

Returns:

boolean

Throws:

org.opendaylight.mdsal.common.api.ReadFailedException - if the read failed

getNeutronLoadBalancerPoolMember

NeutronLoadBalancerPoolMember getNeutronLoadBalancerPoolMember(String poolUuid,
                                                               String uuid)
                                                        throws org.opendaylight.mdsal.common.api.ReadFailedException

Applications call this interface method to return if a particular NeutronLoadBalancerPoolMember object exists.

Parameters:

poolUuid - UUID of the NeutronLoadBalancerPool object

uuid - UUID of the NeutronLoadBalancerPoolMember object

Returns:

NeutronLoadBalancerPoolMember OpenStackNeutronLoadBalancerPoolMember class

Throws:

org.opendaylight.mdsal.common.api.ReadFailedException - if the read failed

getAllNeutronLoadBalancerPoolMembers

List<NeutronLoadBalancerPoolMember> getAllNeutronLoadBalancerPoolMembers(String poolUuid)
                                                                  throws org.opendaylight.mdsal.common.api.ReadFailedException

Applications call this interface method to return all NeutronLoadBalancerPoolMember objects.

Parameters:

poolUuid - UUID of the NeutronLoadBalancerPool object

Returns:

List of OpenStackNetworks objects

Throws:

org.opendaylight.mdsal.common.api.ReadFailedException - if the read failed

addNeutronLoadBalancerPoolMember

boolean addNeutronLoadBalancerPoolMember(String poolUuid,
                                         NeutronLoadBalancerPoolMember input)
                                  throws org.opendaylight.yangtools.yang.common.OperationFailedException

Applications call this interface method to add a NeutronLoadBalancerPoolMember object to the concurrent map.

Parameters:

poolUuid - UUID of the NeutronLoadBalancerPool object

input - OpenStackNetwork object

Returns:

boolean on whether the object was added or not

Throws:

org.opendaylight.yangtools.yang.common.OperationFailedException - if the read or write failed

removeNeutronLoadBalancerPoolMember

boolean removeNeutronLoadBalancerPoolMember(String poolUuid,
                                            String uuid)
                                     throws org.opendaylight.yangtools.yang.common.OperationFailedException

Applications call this interface method to remove a Neutron NeutronLoadBalancerPoolMember object to the concurrent map.

Parameters:

poolUuid - UUID of the NeutronLoadBalancerPool object

uuid - identifier for the NeutronLoadBalancerPoolMember object

Returns:

boolean on whether the object was removed or not

Throws:

org.opendaylight.yangtools.yang.common.OperationFailedException - if the read or write failed

updateNeutronLoadBalancerPoolMember

boolean updateNeutronLoadBalancerPoolMember(String poolUuid,
                                            String uuid,
                                            NeutronLoadBalancerPoolMember delta)
                                     throws org.opendaylight.yangtools.yang.common.OperationFailedException

Applications call this interface method to edit a NeutronLoadBalancerPoolMember object.

Parameters:

poolUuid - identifier of the NeutronLoadBalancerPool object

uuid - identifier of the NeutronLoadBalancerPoolMember object

delta - OpenStackNeutronLoadBalancerPoolMember object containing changes to apply

Returns:

boolean on whether the object was updated or not

Throws:

org.opendaylight.yangtools.yang.common.OperationFailedException - if the read or write operation failed

neutronLoadBalancerPoolMemberInUse

boolean neutronLoadBalancerPoolMemberInUse(String poolUuid,
                                           String uuid)
                                    throws org.opendaylight.mdsal.common.api.ReadFailedException

Applications call this interface method to see if a MAC address is in use.

Parameters:

poolUuid - identifier of the NeutronLoadBalancerPool object

uuid - identifier of the NeutronLoadBalancerPoolMember object

Returns:

boolean on whether the macAddress is already associated with a port or not

Throws:

org.opendaylight.mdsal.common.api.ReadFailedException - if the read operation failed