alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 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.net.flowobjective; |
| 17 | |
Thomas Vachuska | a9d491e | 2015-05-20 11:17:21 -0700 | [diff] [blame] | 18 | import com.google.common.annotations.Beta; |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 19 | import org.onosproject.core.ApplicationId; |
| 20 | |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 21 | import java.util.Optional; |
| 22 | |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 23 | /** |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 24 | * Base representation of a flow-objective description. |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 25 | */ |
Thomas Vachuska | a9d491e | 2015-05-20 11:17:21 -0700 | [diff] [blame] | 26 | @Beta |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 27 | public interface Objective { |
| 28 | |
Sho SHIMIZU | e2952e4 | 2015-09-11 17:11:21 -0700 | [diff] [blame] | 29 | boolean DEFAULT_PERMANENT = true; |
| 30 | int DEFAULT_TIMEOUT = 0; |
| 31 | int DEFAULT_PRIORITY = 32768; |
Jayasree Ghosh | 3684dc7 | 2016-06-09 18:07:19 +0530 | [diff] [blame] | 32 | int MIN_PRIORITY = 0; |
| 33 | int MAX_PRIORITY = 65535; |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Type of operation. |
| 37 | */ |
| 38 | enum Operation { |
| 39 | /** |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 40 | * Adds the objective. Can be used for any flow objective. For forwarding |
| 41 | * and filtering objectives, existing objectives with identical selector |
| 42 | * and priority fields (but different treatments or next) will be replaced. |
| 43 | * For next objectives, if modification is desired, ADD will not |
| 44 | * do anything - use ADD_TO_EXISTING. |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 45 | */ |
| 46 | ADD, |
| 47 | |
| 48 | /** |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 49 | * Removes the objective. Can be used for any flow objective. |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 50 | */ |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 51 | REMOVE, |
| 52 | |
| 53 | /** |
| 54 | * Add to an existing Next Objective. Should not be used for any other |
| 55 | * objective. |
| 56 | */ |
| 57 | ADD_TO_EXISTING, |
| 58 | |
| 59 | /** |
| 60 | * Remove from an existing Next Objective. Should not be used for any |
| 61 | * other objective. |
| 62 | */ |
Saurav Das | ceccf24 | 2017-08-03 18:30:35 -0700 | [diff] [blame] | 63 | REMOVE_FROM_EXISTING, |
| 64 | |
| 65 | /** |
| 66 | * Verifies that an existing Next Objective's collection of treatments |
| 67 | * are correctly represented by the underlying implementation of the objective. |
| 68 | * Corrective action is taken if discrepancies are found during verification. |
| 69 | * For example, if the next objective defines 3 sets of treatments, which |
| 70 | * are meant to be implemented as 3 buckets in a group, but verification |
| 71 | * finds less or more buckets, then the appropriate buckets are added or |
| 72 | * removed to match the objective. |
| 73 | * |
| 74 | * Should not be used for any other objective. |
| 75 | */ |
| 76 | VERIFY |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 77 | } |
| 78 | |
| 79 | /** |
| 80 | * An identifier for this objective. |
| 81 | * |
| 82 | * @return an integer |
| 83 | */ |
| 84 | int id(); |
| 85 | |
| 86 | /** |
| 87 | * The priority for this objective. |
| 88 | * |
| 89 | * @return an integer |
| 90 | */ |
| 91 | int priority(); |
| 92 | |
| 93 | /** |
| 94 | * The application which applied this objective. |
| 95 | * |
| 96 | * @return an application id |
| 97 | */ |
| 98 | ApplicationId appId(); |
| 99 | |
| 100 | /** |
| 101 | * The timeout for this objective. |
| 102 | * |
| 103 | * @return an integer |
| 104 | */ |
| 105 | int timeout(); |
| 106 | |
| 107 | /** |
| 108 | * Whether this objective is permanent. |
| 109 | * |
| 110 | * @return a boolean |
| 111 | */ |
| 112 | boolean permanent(); |
| 113 | |
| 114 | /** |
| 115 | * The type of operation for this objective. |
| 116 | * |
| 117 | * @return an operation |
| 118 | */ |
| 119 | Operation op(); |
| 120 | |
| 121 | /** |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 122 | * Obtains an optional context. |
| 123 | * |
| 124 | * @return optional; which will be empty if there is no context. |
| 125 | * Otherwise it will return the context. |
| 126 | */ |
| 127 | Optional<ObjectiveContext> context(); |
| 128 | |
| 129 | /** |
Thomas Vachuska | 00f4816 | 2016-02-29 17:07:23 -0800 | [diff] [blame] | 130 | * Returns a new builder set to create a copy of this objective. |
| 131 | * |
| 132 | * @return new builder |
| 133 | */ |
| 134 | Objective.Builder copy(); |
| 135 | |
| 136 | /** |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 137 | * An objective builder. |
| 138 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 139 | interface Builder { |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 140 | /** |
| 141 | * Makes the filtering objective temporary. |
| 142 | * |
| 143 | * @param timeout a timeout |
| 144 | * @return an objective builder |
| 145 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 146 | Builder makeTemporary(int timeout); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 147 | |
| 148 | /** |
| 149 | * Makes the filtering objective permanent. |
| 150 | * |
| 151 | * @return an objective builder |
| 152 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 153 | Builder makePermanent(); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 154 | |
| 155 | /** |
| 156 | * Specifies the application which applied the filter. |
| 157 | * |
| 158 | * @param appId an application id |
| 159 | * @return an objective builder |
| 160 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 161 | Builder fromApp(ApplicationId appId); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 162 | |
| 163 | /** |
| 164 | * Sets the priority for this objective. |
| 165 | * |
| 166 | * @param priority an integer |
| 167 | * @return an objective builder |
| 168 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 169 | Builder withPriority(int priority); |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 170 | |
Thomas Vachuska | 00f4816 | 2016-02-29 17:07:23 -0800 | [diff] [blame] | 171 | /** |
| 172 | * Builds the objective that will be added. |
| 173 | * |
| 174 | * @return an objective |
| 175 | */ |
| 176 | Objective add(); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 177 | |
Thomas Vachuska | 00f4816 | 2016-02-29 17:07:23 -0800 | [diff] [blame] | 178 | /** |
| 179 | * Builds the objective that will be removed. |
| 180 | * |
| 181 | * @return an objective. |
| 182 | */ |
| 183 | Objective remove(); |
| 184 | |
| 185 | /** |
| 186 | * Builds the objective that will be added. |
| 187 | * The context will be used to notify the calling application. |
| 188 | * |
| 189 | * @param context an objective context |
| 190 | * @return an objective |
| 191 | */ |
| 192 | Objective add(ObjectiveContext context); |
| 193 | |
| 194 | /** |
| 195 | * Builds the objective that will be removed. |
| 196 | * The context will be used to notify the calling application. |
| 197 | * |
| 198 | * @param context an objective context |
| 199 | * @return an objective |
| 200 | */ |
| 201 | Objective remove(ObjectiveContext context); |
| 202 | } |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 203 | } |