sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.segmentrouting; |
| 17 | |
| 18 | import java.util.List; |
| 19 | |
| 20 | /** |
| 21 | * Segment Routing Service for REST API. |
| 22 | */ |
| 23 | public interface SegmentRoutingService { |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 24 | /** |
| 25 | * Segment Routing App ID. |
| 26 | */ |
| 27 | String SR_APP_ID = "org.onosproject.segmentrouting"; |
| 28 | |
| 29 | /** |
| 30 | * Highest flow priority. |
| 31 | */ |
| 32 | int HIGHEST_PRIORITY = 0xffff; |
| 33 | |
| 34 | /** |
| 35 | * VLAN cross-connect priority. |
| 36 | */ |
| 37 | int XCONNECT_PRIORITY = 1000; |
| 38 | |
| 39 | /** |
| 40 | * Default flow priority. |
| 41 | */ |
| 42 | int DEFAULT_PRIORITY = 100; |
| 43 | |
| 44 | /** |
| 45 | * Minimum IP priority. |
| 46 | * |
| 47 | * Should > 0 such that priority of /0 will not conflict with lowest |
| 48 | * priority default entries. |
| 49 | */ |
| 50 | int MIN_IP_PRIORITY = 10; |
| 51 | |
| 52 | /** |
| 53 | * Subnet flooding flow priority. |
| 54 | */ |
| 55 | int FLOOD_PRIORITY = 5; |
| 56 | |
| 57 | long OFPP_MAX = 0xffffff00L; |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * Returns all tunnels. |
| 61 | * |
| 62 | * @return list of tunnels |
| 63 | */ |
| 64 | List<Tunnel> getTunnels(); |
| 65 | |
| 66 | /** |
| 67 | * Creates a tunnel. |
| 68 | * |
| 69 | * @param tunnel tunnel reference to create |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 70 | * @return WRONG_PATH if the tunnel path is wrong, ID_EXISTS if the tunnel ID |
| 71 | * exists already, TUNNEL_EXISTS if the same tunnel exists, INTERNAL_ERROR |
| 72 | * if the tunnel creation failed internally, SUCCESS if the tunnel is created |
| 73 | * successfully |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 74 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 75 | TunnelHandler.Result createTunnel(Tunnel tunnel); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Returns all policies. |
| 79 | * |
| 80 | * @return list of policy |
| 81 | */ |
| 82 | List<Policy> getPolicies(); |
| 83 | |
| 84 | /** |
| 85 | * Creates a policy. |
| 86 | * |
| 87 | * @param policy policy reference to create |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 88 | * @return ID_EXISTS if the same policy ID exists, |
| 89 | * POLICY_EXISTS if the same policy exists, TUNNEL_NOT_FOUND if the tunnel |
| 90 | * does not exists, UNSUPPORTED_TYPE if the policy type is not supported, |
| 91 | * SUCCESS if the policy is created successfully. |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 92 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 93 | PolicyHandler.Result createPolicy(Policy policy); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 94 | |
| 95 | /** |
| 96 | * Removes a tunnel. |
| 97 | * |
| 98 | * @param tunnel tunnel reference to remove |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 99 | * @return TUNNEL_NOT_FOUND if the tunnel to remove does not exists, |
| 100 | * INTERNAL_ERROR if the tunnel creation failed internally, SUCCESS |
| 101 | * if the tunnel is created successfully. |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 102 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 103 | TunnelHandler.Result removeTunnel(Tunnel tunnel); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 104 | |
| 105 | /** |
| 106 | * Removes a policy. |
| 107 | * |
| 108 | * @param policy policy reference to remove |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 109 | * @return POLICY_NOT_FOUND if the policy to remove does not exists, |
| 110 | * SUCCESS if it is removed successfully |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 111 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 112 | PolicyHandler.Result removePolicy(Policy policy); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 113 | } |