Convert neutron service base classes to unix line delimiters.
[controller.git] / opendaylight / networkconfiguration / neutron / src / main / java / org / opendaylight / controller / networkconfig / neutron / INeutronPortCRUD.java
1 /*
2  * Copyright IBM Corporation, 2013.  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.controller.networkconfig.neutron;
10
11 import java.util.List;
12
13 /**
14  * This interface defines the methods for CRUD of NB Port objects
15  *
16  */
17
18 public interface INeutronPortCRUD {
19     /**
20      * Applications call this interface method to determine if a particular
21      * Port object exists
22      *
23      * @param uuid
24      *            UUID of the Port object
25      * @return boolean
26      */
27
28     public boolean portExists(String uuid);
29
30     /**
31      * Applications call this interface method to return if a particular
32      * Port object exists
33      *
34      * @param uuid
35      *            UUID of the Port object
36      * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronPort.OpenStackPorts}
37      *          OpenStack Port class
38      */
39
40     public NeutronPort getPort(String uuid);
41
42     /**
43      * Applications call this interface method to return all Port objects
44      *
45      * @return List of OpenStackPorts objects
46      */
47
48     public List<NeutronPort> getAllPorts();
49
50     /**
51      * Applications call this interface method to add a Port object to the
52      * concurrent map
53      *
54      * @param input
55      *            OpenStackPort object
56      * @return boolean on whether the object was added or not
57      */
58
59     public boolean addPort(NeutronPort input);
60
61     /**
62      * Applications call this interface method to remove a Port object to the
63      * concurrent map
64      *
65      * @param uuid
66      *            identifier for the Port object
67      * @return boolean on whether the object was removed or not
68      */
69
70     public boolean removePort(String uuid);
71
72     /**
73      * Applications call this interface method to edit a Port object
74      *
75      * @param uuid
76      *            identifier of the Port object
77      * @param delta
78      *            OpenStackPort object containing changes to apply
79      * @return boolean on whether the object was updated or not
80      */
81
82     public boolean updatePort(String uuid, NeutronPort delta);
83
84     /**
85      * Applications call this interface method to see if a MAC address is in use
86      *
87      * @param macAddress
88      *            mac Address to be tested
89      * @return boolean on whether the macAddress is already associated with a
90      * port or not
91      */
92
93     public boolean macInUse(String macAddress);
94
95     /**
96      * Applications call this interface method to retrieve the port associated with
97      * the gateway address of a subnet
98      *
99      * @param subnetUUID
100      *            identifier of the subnet
101      * @return OpenStackPorts object if the port exists and null if it does not
102      */
103
104     public NeutronPort getGatewayPort(String subnetUUID);
105 }