Package org.opendaylight.neutron.spi

Interface INeutronCRUD<T extends INeutronObject<T>>

All Known Subinterfaces:

INeutronBgpvpnCRUD, INeutronFirewallCRUD, INeutronFirewallPolicyCRUD, INeutronFirewallRuleCRUD, INeutronFloatingIpCRUD, INeutronL2gatewayConnectionCRUD, INeutronL2gatewayCRUD, INeutronLoadBalancerCRUD, INeutronLoadBalancerHealthMonitorCRUD, INeutronLoadBalancerListenerCRUD, INeutronLoadBalancerPoolCRUD, INeutronMeteringLabelCRUD, INeutronMeteringLabelRuleCRUD, INeutronNetworkCRUD, INeutronPortCRUD, INeutronQosPolicyCRUD, INeutronRouterCRUD, INeutronSecurityGroupCRUD, INeutronSecurityRuleCRUD, INeutronSFCFlowClassifierCRUD, INeutronSFCPortChainCRUD, INeutronSFCPortPairCRUD, INeutronSFCPortPairGroupCRUD, INeutronSubnetCRUD, INeutronTapFlowCRUD, INeutronTapServiceCRUD, INeutronTrunkCRUD, INeutronVpnIkePolicyCRUD, INeutronVpnIpSecPolicyCRUD, INeutronVpnIpSecSiteConnectionsCRUD, INeutronVpnServiceCRUD

All Known Implementing Classes:

AbstractNeutronInterface, AbstractTranscriberInterface, NeutronBgpvpnInterface, NeutronFirewallInterface, NeutronFirewallPolicyInterface, NeutronFirewallRuleInterface, NeutronFloatingIpInterface, NeutronL2gatewayConnectionInterface, NeutronL2gatewayInterface, NeutronLoadBalancerHealthMonitorInterface, NeutronLoadBalancerInterface, NeutronLoadBalancerListenerInterface, NeutronLoadBalancerPoolInterface, NeutronMeteringLabelInterface, NeutronMeteringLabelRuleInterface, NeutronNetworkInterface, NeutronPortInterface, NeutronQosPolicyInterface, NeutronRouterInterface, NeutronSecurityGroupInterface, NeutronSecurityRuleInterface, NeutronSFCFlowClassifierInterface, NeutronSFCPortChainInterface, NeutronSFCPortPairGroupInterface, NeutronSFCPortPairInterface, NeutronSubnetInterface, NeutronTapFlowInterface, NeutronTapServiceInterface, NeutronTrunkInterface, NeutronVpnIkePolicyInterface, NeutronVpnIpSecPolicyInterface, NeutronVpnIpSecSiteConnectionsInterface, NeutronVpnServiceInterface

public interface INeutronCRUD<T extends INeutronObject<T>>

This interface defines the methods for CRUD of NB neutron objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	INeutronCRUD.Result

Method Summary

Modifier and Type	Method	Description
INeutronCRUD.Result	add(T input)	Applications call this interface method to add a Neutron object to the concurrent map.
boolean	exists(String uuid, org.opendaylight.controller.md.sal.binding.api.ReadTransaction tx)	Applications call this interface method to determine if a particular Neutron object exists.
T	get(String uuid)	Applications call this interface method to return if a particular Neutron object exists.
List<T>	getAll()	Applications call this interface method to return all Neutron objects.
boolean	remove(String uuid)	Applications call this interface method to remove a Neutron object to the concurrent map.
INeutronCRUD.Result	update(String uuid, T delta)	Applications call this interface method to edit a Neutron object.

Method Detail

exists

boolean exists(String uuid,
               org.opendaylight.controller.md.sal.binding.api.ReadTransaction tx)
        throws org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

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

Parameters:

uuid - UUID of the Neutron object

tx - the ReadTransaction within which to perform the check

Returns:

boolean

Throws:

org.opendaylight.controller.md.sal.common.api.data.ReadFailedException - if the read failed

get

T get(String uuid)
throws org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

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

Parameters:

uuid - UUID of the Neutron object

Returns:

INeutronObject OpenStack Neutron class

Throws:

org.opendaylight.controller.md.sal.common.api.data.ReadFailedException - if the read failed

getAll

List<T> getAll()
        throws ReadFailedRuntimeException

Applications call this interface method to return all Neutron objects.

Returns:

List of OpenStackNeutrons objects

Throws:

ReadFailedRuntimeException - if the read failed

add

INeutronCRUD.Result add(T input)
                 throws org.opendaylight.yangtools.yang.common.OperationFailedException

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

Parameters:

input - OpenStackNeutron object

Returns:

result with indication on whether the object was added or not and if so why

Throws:

org.opendaylight.yangtools.yang.common.OperationFailedException - if the write (or a required implicit read) failed

remove

boolean remove(String uuid)
        throws org.opendaylight.yangtools.yang.common.OperationFailedException

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

Parameters:

uuid - identifier for the neutron object

Returns:

boolean on whether the object was removed or not

Throws:

org.opendaylight.yangtools.yang.common.OperationFailedException - if the remove (or a required implicit read) failed

update

INeutronCRUD.Result update(String uuid,
                           T delta)
                    throws org.opendaylight.yangtools.yang.common.OperationFailedException

Applications call this interface method to edit a Neutron object.

Parameters:

uuid - identifier of the neutron object

delta - OpenStackNeutron object containing changes to apply

Returns:

boolean on whether the object was updated or not

Throws:

org.opendaylight.yangtools.yang.common.OperationFailedException - if the update (or a required implicit read) failed