Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 2 | * Copyright 2018-present Open Networking Foundation |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -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.incubator.net.domain; |
| 17 | |
| 18 | import com.google.common.annotations.Beta; |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 19 | import org.onosproject.net.provider.Provider; |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 20 | |
| 21 | import java.util.List; |
| 22 | import java.util.Set; |
| 23 | |
| 24 | /** |
| 25 | * FIXME. |
| 26 | */ |
| 27 | @Beta |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 28 | public interface IntentDomainProvider extends Provider { |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 29 | |
| 30 | /** |
| 31 | * Requests that the provider attempt to satisfy the intent primitive. |
| 32 | * The application must apply the context before the intent resource |
| 33 | * can be used. Request contexts can be explictly cancelled, or they will |
| 34 | * eventually time out so that resources can be reused. |
| 35 | * |
Brian O'Connor | 59a9285 | 2015-07-30 19:08:24 -0700 | [diff] [blame] | 36 | * @param domain intent domain for the request |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 37 | * @param primitive intent primitive |
Aaron Kruglikov | b4916d0 | 2015-09-08 16:22:25 -0700 | [diff] [blame] | 38 | * @return intent resources that specify paths that satisfy the request. |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 39 | */ |
| 40 | //TODO Consider an iterable and/or holds (only hold one or two reservation(s) at a time) |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 41 | List<IntentResource> request(IntentDomain domain, IntentPrimitive primitive); |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 42 | |
| 43 | /** |
| 44 | * Request that the provider attempt to modify an existing resource to satisfy |
| 45 | * a new intent primitive. The application must apply the context before |
| 46 | * the intent resource can be used. |
| 47 | * |
Aaron Kruglikov | b4916d0 | 2015-09-08 16:22:25 -0700 | [diff] [blame] | 48 | * @param oldResource the resource to be replaced |
| 49 | * @param newResource the resource to be applied |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 50 | * @return request contexts that contain resources to satisfy the intent |
| 51 | */ |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 52 | IntentResource modify(IntentResource oldResource, IntentResource newResource); |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Requests that the provider release an intent resource. |
| 56 | * |
| 57 | * @param resource intent resource |
| 58 | */ |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 59 | void release(IntentResource resource); |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 60 | |
| 61 | /** |
Aaron Kruglikov | b4916d0 | 2015-09-08 16:22:25 -0700 | [diff] [blame] | 62 | * Requests that the provider apply the path from the intent resource. |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 63 | * |
Aaron Kruglikov | b4916d0 | 2015-09-08 16:22:25 -0700 | [diff] [blame] | 64 | * @param domainIntentResource request context |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 65 | * @return intent resource that satisfies the intent |
| 66 | */ |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 67 | IntentResource apply(IntentResource domainIntentResource); |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 68 | |
| 69 | /** |
Aaron Kruglikov | b4916d0 | 2015-09-08 16:22:25 -0700 | [diff] [blame] | 70 | * Requests that the provider cancel the path. Requests that are not applied |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 71 | * will be eventually timed out by the provider. |
| 72 | * |
Aaron Kruglikov | b4916d0 | 2015-09-08 16:22:25 -0700 | [diff] [blame] | 73 | * @param domainIntentResource the intent resource whose path should be cancelled. |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 74 | */ |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 75 | void cancel(IntentResource domainIntentResource); |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Returns all intent resources held by the provider. |
| 79 | * |
| 80 | * @return set of intent resources |
| 81 | */ |
Brian O'Connor | bd7f878 | 2015-11-19 23:12:37 -0800 | [diff] [blame] | 82 | Set<IntentResource> getResources(); |
Brian O'Connor | b7baf71 | 2015-07-28 23:27:03 -0700 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | |