2 * Copyright IBM Corporation, 2013. All rights reserved.
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
9 package org.opendaylight.controller.networkconfig.neutron;
11 import java.util.List;
14 * This interface defines the methods for CRUD of NB Port objects
18 public interface INeutronPortCRUD {
20 * Applications call this interface method to determine if a particular
24 * UUID of the Port object
28 public boolean portExists(String uuid);
31 * Applications call this interface method to return if a particular
35 * UUID of the Port object
36 * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronPort.OpenStackPorts}
37 * OpenStack Port class
40 public NeutronPort getPort(String uuid);
43 * Applications call this interface method to return all Port objects
45 * @return List of OpenStackPorts objects
48 public List<NeutronPort> getAllPorts();
51 * Applications call this interface method to add a Port object to the
55 * OpenStackPort object
56 * @return boolean on whether the object was added or not
59 public boolean addPort(NeutronPort input);
62 * Applications call this interface method to remove a Port object to the
66 * identifier for the Port object
67 * @return boolean on whether the object was removed or not
70 public boolean removePort(String uuid);
73 * Applications call this interface method to edit a Port object
76 * identifier of the Port object
78 * OpenStackPort object containing changes to apply
79 * @return boolean on whether the object was updated or not
82 public boolean updatePort(String uuid, NeutronPort delta);
85 * Applications call this interface method to see if a MAC address is in use
88 * mac Address to be tested
89 * @return boolean on whether the macAddress is already associated with a
93 public boolean macInUse(String macAddress);
96 * Applications call this interface method to retrieve the port associated with
97 * the gateway address of a subnet
100 * identifier of the subnet
101 * @return OpenStackPorts object if the port exists and null if it does not
104 public NeutronPort getGatewayPort(String subnetUUID);