Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -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 | */ |
Brian O'Connor | 6de2e20 | 2015-05-21 14:30:41 -0700 | [diff] [blame] | 16 | package org.onosproject.net.resource.device; |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 17 | |
Sho SHIMIZU | e825af0 | 2015-07-02 10:14:22 -0700 | [diff] [blame] | 18 | import com.google.common.annotations.Beta; |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 19 | import org.onosproject.net.Port; |
| 20 | import org.onosproject.net.intent.Intent; |
| 21 | import org.onosproject.net.intent.IntentId; |
| 22 | |
| 23 | import java.util.Set; |
| 24 | |
| 25 | /** |
| 26 | * Service for providing device resources. |
| 27 | */ |
Sho SHIMIZU | e825af0 | 2015-07-02 10:14:22 -0700 | [diff] [blame] | 28 | @Beta |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 29 | public interface DeviceResourceService { |
| 30 | /** |
| 31 | * Request a set of ports needed to satisfy the intent. |
| 32 | * |
Marc De Leenheer | 8c2caac | 2015-05-28 16:37:33 -0700 | [diff] [blame] | 33 | * @param ports set of ports to allocate |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 34 | * @param intent the intent |
Marc De Leenheer | 8c2caac | 2015-05-28 16:37:33 -0700 | [diff] [blame] | 35 | * @return true if ports were successfully allocated, false otherwise |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 36 | */ |
Marc De Leenheer | 8c2caac | 2015-05-28 16:37:33 -0700 | [diff] [blame] | 37 | boolean requestPorts(Set<Port> ports, Intent intent); |
| 38 | |
| 39 | /** |
| 40 | * Returns the set of ports allocated for an intent. |
| 41 | * |
| 42 | * @param intentId the intent ID |
| 43 | * @return set of allocated ports |
| 44 | */ |
| 45 | Set<Port> getAllocations(IntentId intentId); |
| 46 | |
| 47 | /** |
| 48 | * Returns the intent allocated to a port. |
| 49 | * |
| 50 | * @param port the port |
| 51 | * @return intent ID allocated to the port |
| 52 | */ |
| 53 | IntentId getAllocations(Port port); |
| 54 | |
| 55 | /** |
| 56 | * Request a mapping between the given intents. |
| 57 | * |
| 58 | * @param keyIntentId the key intent ID |
| 59 | * @param valIntentId the value intent ID |
| 60 | * @return true if mapping was successful, false otherwise |
| 61 | */ |
| 62 | boolean requestMapping(IntentId keyIntentId, IntentId valIntentId); |
| 63 | |
| 64 | /** |
| 65 | * Returns the intents mapped to a lower intent. |
| 66 | * |
| 67 | * @param intentId the intent ID |
| 68 | * @return the set of intent IDs |
| 69 | */ |
| 70 | Set<IntentId> getMapping(IntentId intentId); |
| 71 | |
Marc De Leenheer | 9f7d189 | 2015-05-30 13:22:24 -0700 | [diff] [blame] | 72 | /** |
| 73 | * Release mapping of given intent. |
| 74 | * |
| 75 | * @param intentId intent ID |
| 76 | */ |
| 77 | void releaseMapping(IntentId intentId); |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 78 | |
| 79 | /** |
| 80 | * Release ports associated with given intent ID. |
| 81 | * |
| 82 | * @param intentId intent ID |
| 83 | */ |
| 84 | void releasePorts(IntentId intentId); |
| 85 | } |