| package org.onosproject.net.resource; |
| |
| import java.util.Collection; |
| import java.util.Set; |
| |
| import org.onosproject.net.DeviceId; |
| |
| import com.google.common.collect.Multimap; |
| |
| /** |
| * Service for providing label resource allocation. |
| */ |
| public interface LabelResourceService { |
| |
| /** |
| * Returns labels from resource pool by a specific device id. |
| * |
| * @param deviceId device identifier |
| * @param applyNum the applying number |
| * @return collection of applying labels |
| */ |
| Collection<LabelResource> applyFromDevicePool(DeviceId deviceId, |
| long applyNum); |
| |
| /** |
| * Returns labels from the global label resource pool. |
| * |
| * @param applyNum the applying number |
| * @return collection of applying labels |
| */ |
| Collection<LabelResource> applyFromGlobalPool(long applyNum); |
| |
| /** |
| * Releases unused labels to device pools . |
| * |
| * @param release the collection of releasing labels |
| * @return success or fail |
| */ |
| boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release); |
| |
| /** |
| * Releases unused labels to the global resource pool. |
| * |
| * @param release release the collection of releasing labels |
| * @return success or fail |
| */ |
| boolean releaseToGlobalPool(Set<LabelResourceId> release); |
| |
| /** |
| * Judges if the pool of a specific device id is full. |
| * |
| * @param deviceId device identifier |
| * @return yes or no |
| */ |
| boolean isDevicePoolFull(DeviceId deviceId); |
| |
| /** |
| * Judges if the global resource pool is full. |
| * |
| * @return yes or no |
| */ |
| boolean isGlobalPoolFull(); |
| |
| /** |
| * Returns the unused label number of a label resource pool by a specific device |
| * id. |
| * |
| * @param deviceId device identifier |
| * @return number of unused labels |
| */ |
| long getFreeNumOfDevicePool(DeviceId deviceId); |
| |
| /** |
| * Returns the unused label number of a global label resource pool. |
| * |
| * @return number of unused labels |
| */ |
| long getFreeNumOfGlobalPool(); |
| |
| /** |
| * Returns the label resource pool of a label resource by a specific device |
| * id. |
| * |
| * @param deviceId device identifier |
| * @return the device label resource pool |
| */ |
| LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId); |
| |
| /** |
| * Returns the global label resource pool. |
| * |
| * @return the global label resource pool |
| */ |
| LabelResourcePool getGlobalLabelResourcePool(); |
| |
| /** |
| * Adds the specified label resource listener. |
| * |
| * @param listener label resource listener |
| */ |
| void addListener(LabelResourceListener listener); |
| |
| /** |
| * Removes the specified label resource listener. |
| * |
| * @param listener label resource listener |
| */ |
| void removeListener(LabelResourceListener listener); |
| } |