| /* |
| * Copyright 2015-2016 Open Networking Laboratory |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.openstacknetworking; |
| |
| import org.onosproject.net.Port; |
| |
| import java.util.Collection; |
| import java.util.Map; |
| |
| /** |
| * Handles port management REST API from Openstack for VMs. |
| */ |
| public interface OpenstackNetworkingService { |
| |
| /** |
| * Returns port information list for the network ID given. |
| * |
| * @param networkId Network ID of the ports |
| * @return port information list |
| */ |
| Collection<OpenstackPort> ports(String networkId); |
| |
| /** |
| * Returns port information list. |
| * |
| * @return port information list |
| */ |
| Collection<OpenstackPort> ports(); |
| /** |
| * Returns port information for the port given. |
| * |
| * @param port port reference |
| * @return port information |
| */ |
| OpenstackPort port(Port port); |
| |
| /** |
| * Returns port information for the port ID given. |
| * |
| * @param portId Port ID |
| * @return port information |
| */ |
| OpenstackPort port(String portId); |
| |
| /** |
| * Returns network information list for the network ID given. |
| * |
| * @param networkId Network ID |
| * @return network information, or null if not present |
| */ |
| OpenstackNetwork network(String networkId); |
| |
| /** |
| * Returns the information of all openstack networks. |
| * |
| * @return collection of network information |
| */ |
| Collection<OpenstackNetwork> networks(); |
| |
| /** |
| * Returns subnet information for the subnet ID give. |
| * |
| * @param subnetId Subnet ID |
| * @return subnet information, or null if not present |
| */ |
| OpenstackSubnet subnet(String subnetId); |
| |
| /** |
| * Returns collection of openstack subnet information. |
| * |
| * @return collection of openststack subnet information |
| */ |
| Collection<OpenstackSubnet> subnets(); |
| |
| /** |
| * Returns the router information list. |
| * |
| * @return router information list |
| */ |
| Collection<OpenstackRouter> routers(); |
| |
| /** |
| * Returns the router information for the router ID given. |
| * |
| * @param routerId router ID |
| * @return router information |
| */ |
| OpenstackRouter router(String routerId); |
| |
| /** |
| * Retruns OpenstackPortInfo map. |
| * |
| * @return OpenstackPortInfo map |
| */ |
| Map<String, OpenstackPortInfo> openstackPortInfo(); |
| |
| /** |
| * Sets configurations specified by net-config.xml file. |
| * |
| * @param neutronUrl neutron server url |
| * @param keystoneUrl keystone server url |
| * @param userName horizon user name |
| * @param pass horizon passowrd |
| */ |
| void setConfigurations(String neutronUrl, String keystoneUrl, String userName, String pass); |
| |
| /** |
| * Returns Security Group information of the security groupd id given. |
| * |
| * @param id security group id |
| * @return security group information |
| */ |
| OpenstackSecurityGroup getSecurityGroup(String id); |
| |
| } |