2 * Copyright IBM Corporation, 2013. All rights reserved.
\r
4 * This program and the accompanying materials are made available under the
\r
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
\r
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
\r
9 package org.opendaylight.controller.networkconfig.neutron;
\r
11 import java.util.List;
\r
14 * This interface defines the methods for CRUD of NB Port objects
\r
18 public interface INeutronPortCRUD {
\r
20 * Applications call this interface method to determine if a particular
\r
21 * Port object exists
\r
24 * UUID of the Port object
\r
28 public boolean portExists(String uuid);
\r
31 * Applications call this interface method to return if a particular
\r
32 * Port object exists
\r
35 * UUID of the Port object
\r
36 * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronPort.OpenStackPorts}
\r
37 * OpenStack Port class
\r
40 public NeutronPort getPort(String uuid);
\r
43 * Applications call this interface method to return all Port objects
\r
45 * @return List of OpenStackPorts objects
\r
48 public List<NeutronPort> getAllPorts();
\r
51 * Applications call this interface method to add a Port object to the
\r
55 * OpenStackPort object
\r
56 * @return boolean on whether the object was added or not
\r
59 public boolean addPort(NeutronPort input);
\r
62 * Applications call this interface method to remove a Port object to the
\r
66 * identifier for the Port object
\r
67 * @return boolean on whether the object was removed or not
\r
70 public boolean removePort(String uuid);
\r
73 * Applications call this interface method to edit a Port object
\r
76 * identifier of the Port object
\r
78 * OpenStackPort object containing changes to apply
\r
79 * @return boolean on whether the object was updated or not
\r
82 public boolean updatePort(String uuid, NeutronPort delta);
\r
85 * Applications call this interface method to see if a MAC address is in use
\r
88 * mac Address to be tested
\r
89 * @return boolean on whether the macAddress is already associated with a
\r
93 public boolean macInUse(String macAddress);
\r
96 * Applications call this interface method to retrieve the port associated with
\r
97 * the gateway address of a subnet
\r
100 * identifier of the subnet
\r
101 * @return OpenStackPorts object if the port exists and null if it does not
\r
104 public NeutronPort getGatewayPort(String subnetUUID);
\r