Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.resource; |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 17 | |
| 18 | import java.util.Set; |
| 19 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.net.Link; |
| 21 | import org.onosproject.net.intent.IntentId; |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 22 | |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 23 | /** |
| 24 | * Manages link resources. |
| 25 | */ |
| 26 | public interface LinkResourceStore { |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Returns free resources for given link. |
| 29 | * |
| 30 | * @param link a target link |
| 31 | * @return free resources for given link |
| 32 | */ |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 33 | Set<ResourceAllocation> getFreeResources(Link link); |
| 34 | |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Allocates resources. |
| 37 | * |
| 38 | * @param allocations resources to be allocated |
| 39 | */ |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 40 | void allocateResources(LinkResourceAllocations allocations); |
| 41 | |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 42 | /** |
| 43 | * Releases resources. |
| 44 | * |
| 45 | * @param allocations resources to be released |
Pavlin Radoslavov | 119fd5c | 2014-11-25 19:08:19 -0800 | [diff] [blame] | 46 | * @return the link resource event |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 47 | */ |
Ray Milkey | e97ede9 | 2014-11-20 10:43:12 -0800 | [diff] [blame] | 48 | LinkResourceEvent releaseResources(LinkResourceAllocations allocations); |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 49 | |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 50 | /** |
| 51 | * Returns resources allocated for an Intent. |
| 52 | * |
| 53 | * @param intentId the target Intent's ID |
Yuta HIGUCHI | 6593489 | 2014-12-04 17:47:44 -0800 | [diff] [blame] | 54 | * @return allocated resources or null if no resource is allocated |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 55 | */ |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 56 | LinkResourceAllocations getAllocations(IntentId intentId); |
| 57 | |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 58 | /** |
| 59 | * Returns resources allocated for a link. |
| 60 | * |
| 61 | * @param link the target link |
| 62 | * @return allocated resources |
| 63 | */ |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 64 | Iterable<LinkResourceAllocations> getAllocations(Link link); |
| 65 | |
Toshio Koide | 07df706 | 2014-10-30 10:54:25 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Returns all allocated resources. |
| 68 | * |
| 69 | * @return allocated resources |
| 70 | */ |
Toshio Koide | 106d449 | 2014-10-28 11:22:02 -0700 | [diff] [blame] | 71 | Iterable<LinkResourceAllocations> getAllocations(); |
| 72 | } |