blob: d8d155e614ee61bba53b8f4fb49d0db1e0d6567b [file] [log] [blame]
sangho1e575652015-05-14 00:39:53 -07001/*
Brian O'Connor5ab426f2016-04-09 01:19:45 -07002 * Copyright 2015-present Open Networking Laboratory
sangho1e575652015-05-14 00:39:53 -07003 *
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 */
16package org.onosproject.segmentrouting;
17
Charles Chanc81c45b2016-10-20 17:02:44 -070018import org.onlab.packet.Ip4Prefix;
19import org.onosproject.net.DeviceId;
20
sangho1e575652015-05-14 00:39:53 -070021import java.util.List;
Charles Chanc81c45b2016-10-20 17:02:44 -070022import java.util.Map;
23import java.util.Set;
sangho1e575652015-05-14 00:39:53 -070024
25/**
26 * Segment Routing Service for REST API.
27 */
28public interface SegmentRoutingService {
Charles Chan5270ed02016-01-30 23:22:37 -080029 /**
Charles Chan5270ed02016-01-30 23:22:37 -080030 * 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 *
Charles Chanb54e8ba2016-02-18 10:43:46 -080047 * Should < 0 such that priority of /0 will not conflict with lowest
Charles Chan5270ed02016-01-30 23:22:37 -080048 * priority default entries.
49 */
50 int MIN_IP_PRIORITY = 10;
51
52 /**
53 * Subnet flooding flow priority.
54 */
55 int FLOOD_PRIORITY = 5;
56
sangho1e575652015-05-14 00:39:53 -070057 /**
58 * Returns all tunnels.
59 *
60 * @return list of tunnels
61 */
62 List<Tunnel> getTunnels();
63
64 /**
65 * Creates a tunnel.
66 *
67 * @param tunnel tunnel reference to create
sangho71abe1b2015-06-29 14:58:47 -070068 * @return WRONG_PATH if the tunnel path is wrong, ID_EXISTS if the tunnel ID
69 * exists already, TUNNEL_EXISTS if the same tunnel exists, INTERNAL_ERROR
70 * if the tunnel creation failed internally, SUCCESS if the tunnel is created
71 * successfully
sangho1e575652015-05-14 00:39:53 -070072 */
sangho71abe1b2015-06-29 14:58:47 -070073 TunnelHandler.Result createTunnel(Tunnel tunnel);
sangho1e575652015-05-14 00:39:53 -070074
75 /**
76 * Returns all policies.
77 *
78 * @return list of policy
79 */
80 List<Policy> getPolicies();
81
82 /**
83 * Creates a policy.
84 *
85 * @param policy policy reference to create
sangho71abe1b2015-06-29 14:58:47 -070086 * @return ID_EXISTS if the same policy ID exists,
87 * POLICY_EXISTS if the same policy exists, TUNNEL_NOT_FOUND if the tunnel
88 * does not exists, UNSUPPORTED_TYPE if the policy type is not supported,
89 * SUCCESS if the policy is created successfully.
sangho1e575652015-05-14 00:39:53 -070090 */
sangho71abe1b2015-06-29 14:58:47 -070091 PolicyHandler.Result createPolicy(Policy policy);
sangho1e575652015-05-14 00:39:53 -070092
93 /**
94 * Removes a tunnel.
95 *
96 * @param tunnel tunnel reference to remove
sangho71abe1b2015-06-29 14:58:47 -070097 * @return TUNNEL_NOT_FOUND if the tunnel to remove does not exists,
98 * INTERNAL_ERROR if the tunnel creation failed internally, SUCCESS
99 * if the tunnel is created successfully.
sangho1e575652015-05-14 00:39:53 -0700100 */
sangho71abe1b2015-06-29 14:58:47 -0700101 TunnelHandler.Result removeTunnel(Tunnel tunnel);
sangho1e575652015-05-14 00:39:53 -0700102
103 /**
104 * Removes a policy.
105 *
106 * @param policy policy reference to remove
sangho71abe1b2015-06-29 14:58:47 -0700107 * @return POLICY_NOT_FOUND if the policy to remove does not exists,
108 * SUCCESS if it is removed successfully
sangho1e575652015-05-14 00:39:53 -0700109 */
sangho71abe1b2015-06-29 14:58:47 -0700110 PolicyHandler.Result removePolicy(Policy policy);
Saurav Das59232cf2016-04-27 18:35:50 -0700111
112 /**
113 * Use current state of the network to repopulate forwarding rules.
114 *
115 */
116 void rerouteNetwork();
Charles Chanc81c45b2016-10-20 17:02:44 -0700117
118 /**
119 * Returns device-subnet mapping.
120 *
121 * @return device-subnet mapping
122 */
123 Map<DeviceId, Set<Ip4Prefix>> getDeviceSubnetMap();
sangho1e575652015-05-14 00:39:53 -0700124}