Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 1 | /* |
Sho SHIMIZU | 7e6d18e | 2016-01-07 18:44:33 -0800 | [diff] [blame] | 2 | * Copyright 2015-2016 Open Networking Laboratory |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -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.newresource; |
| 17 | |
| 18 | import com.google.common.annotations.Beta; |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 19 | |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 20 | import java.util.Optional; |
| 21 | |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 22 | /** |
Sho SHIMIZU | 8fa670a | 2016-01-14 11:17:18 -0800 | [diff] [blame] | 23 | * An object that represent a resource in a network. |
| 24 | * A Resource can represents path-like hierarchical structure with its ID. An ID of resource is |
| 25 | * composed of a sequence of elementary resources that are not globally identifiable. A Resource |
| 26 | * can be globally identifiable by its ID. |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 27 | * |
Sho SHIMIZU | 60ac58e | 2015-11-11 12:16:38 -0800 | [diff] [blame] | 28 | * Two types of resource are considered. One is discrete type and the other is continuous type. |
| 29 | * Discrete type resource is a resource whose amount is measured as a discrete unit. VLAN ID and |
| 30 | * MPLS label are examples of discrete type resource. Continuous type resource is a resource whose |
| 31 | * amount is measured as a continuous value. Bandwidth is an example of continuous type resource. |
| 32 | * A double value is associated with a continuous type value. |
| 33 | * |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 34 | * Users of this class must keep the semantics of resources regarding the hierarchical structure. |
Sho SHIMIZU | 8fa670a | 2016-01-14 11:17:18 -0800 | [diff] [blame] | 35 | * For example, resource, Device:1/Port:1/VLAN ID:100, is valid, but resource, |
Sho SHIMIZU | b1f1625 | 2015-11-25 23:03:16 -0800 | [diff] [blame] | 36 | * VLAN ID:100/Device:1/Port:1 is not valid because a link is not a sub-component of a VLAN ID. |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 37 | */ |
| 38 | @Beta |
Sho SHIMIZU | 2a70451 | 2016-01-26 14:41:34 -0800 | [diff] [blame] | 39 | public interface Resource { |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 40 | |
Sho SHIMIZU | 2a70451 | 2016-01-26 14:41:34 -0800 | [diff] [blame] | 41 | DiscreteResource ROOT = new DiscreteResource(); |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 42 | |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 43 | /** |
Sho SHIMIZU | 446fdf0 | 2016-02-11 12:31:11 -0800 | [diff] [blame^] | 44 | * Returns the ID of this resource. |
| 45 | * |
| 46 | * @return the ID of this resource |
| 47 | */ |
| 48 | ResourceId id(); |
| 49 | |
| 50 | /** |
Sho SHIMIZU | 9c02f3a | 2016-01-29 15:11:59 -0800 | [diff] [blame] | 51 | * Checks if the type of this instance is the specified type. |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 52 | * |
Sho SHIMIZU | 9c02f3a | 2016-01-29 15:11:59 -0800 | [diff] [blame] | 53 | * @param ancestorType type of resource to be checked. |
| 54 | * @return true if this resource is under the resource whose type is the given type. |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 55 | */ |
Sho SHIMIZU | 9c02f3a | 2016-01-29 15:11:59 -0800 | [diff] [blame] | 56 | // TODO: find more proper name |
| 57 | boolean isTypeOf(Class<?> ancestorType); |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 58 | |
| 59 | /** |
Sho SHIMIZU | 2d31022 | 2016-01-22 11:45:11 -0800 | [diff] [blame] | 60 | * Returns the volume of this resource. |
| 61 | * |
Sho SHIMIZU | f0fb361 | 2016-01-27 11:45:09 -0800 | [diff] [blame] | 62 | * @param <T> type of return value |
Sho SHIMIZU | 2d31022 | 2016-01-22 11:45:11 -0800 | [diff] [blame] | 63 | * @return the volume of this resource |
| 64 | */ |
| 65 | // TODO: think about other naming possibilities. amount? quantity? |
Sho SHIMIZU | 2a70451 | 2016-01-26 14:41:34 -0800 | [diff] [blame] | 66 | <T> T volume(); |
Sho SHIMIZU | 2d31022 | 2016-01-22 11:45:11 -0800 | [diff] [blame] | 67 | |
| 68 | /** |
Sho SHIMIZU | 446fdf0 | 2016-02-11 12:31:11 -0800 | [diff] [blame^] | 69 | * Returns the last component of this instance. |
| 70 | * |
| 71 | * @return the last component of this instance. |
| 72 | * The return value is equal to the last object of {@code components()}. |
| 73 | */ |
| 74 | Object last(); |
| 75 | |
| 76 | /** |
Sho SHIMIZU | 19816f4 | 2016-01-29 11:32:02 -0800 | [diff] [blame] | 77 | * Returns the parent resource of this instance. |
| 78 | * E.g. if this resource is Link:1/VLAN ID:100, the return value is the resource for Link:1. |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 79 | * |
Sho SHIMIZU | 19816f4 | 2016-01-29 11:32:02 -0800 | [diff] [blame] | 80 | * @return the parent resource of this instance. |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 81 | * If there is no parent, empty instance will be returned. |
| 82 | */ |
Sho SHIMIZU | 2a70451 | 2016-01-26 14:41:34 -0800 | [diff] [blame] | 83 | Optional<DiscreteResource> parent(); |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 84 | |
Sho SHIMIZU | 9e1e9de | 2015-11-25 15:48:48 -0800 | [diff] [blame] | 85 | /** |
Sho SHIMIZU | 19816f4 | 2016-01-29 11:32:02 -0800 | [diff] [blame] | 86 | * Returns a child resource of this instance with specifying the child object. |
| 87 | * It is not allowed that a continuous type resource has a child. If the instance is |
| 88 | * ContinuousResource, {@link UnsupportedOperationException} is thrown. If the given |
| 89 | * object is a {@link Class} instance, {@link IllegalArgumentException} is thrown. |
Sho SHIMIZU | 9e1e9de | 2015-11-25 15:48:48 -0800 | [diff] [blame] | 90 | * |
| 91 | * @param child child object |
Sho SHIMIZU | 19816f4 | 2016-01-29 11:32:02 -0800 | [diff] [blame] | 92 | * @return a child resource |
| 93 | * @throws IllegalArgumentException if the given object is a {@link Class} instance. |
Sho SHIMIZU | 9e1e9de | 2015-11-25 15:48:48 -0800 | [diff] [blame] | 94 | */ |
Sho SHIMIZU | 2a70451 | 2016-01-26 14:41:34 -0800 | [diff] [blame] | 95 | DiscreteResource child(Object child); |
Sho SHIMIZU | 60ac58e | 2015-11-11 12:16:38 -0800 | [diff] [blame] | 96 | |
Sho SHIMIZU | 9e1e9de | 2015-11-25 15:48:48 -0800 | [diff] [blame] | 97 | /** |
Sho SHIMIZU | 19816f4 | 2016-01-29 11:32:02 -0800 | [diff] [blame] | 98 | * Returns a child resource of this instance with specifying a child object and |
| 99 | * value. It is not allowed that a continuous type resource has a child. If the instance is |
| 100 | * ContinuousResource, {@link UnsupportedOperationException} is thrown. |
Sho SHIMIZU | 9e1e9de | 2015-11-25 15:48:48 -0800 | [diff] [blame] | 101 | * |
| 102 | * @param child child object |
| 103 | * @param value value |
Sho SHIMIZU | 19816f4 | 2016-01-29 11:32:02 -0800 | [diff] [blame] | 104 | * @return a child resource |
Sho SHIMIZU | 9e1e9de | 2015-11-25 15:48:48 -0800 | [diff] [blame] | 105 | */ |
Sho SHIMIZU | 2a70451 | 2016-01-26 14:41:34 -0800 | [diff] [blame] | 106 | ContinuousResource child(Class<?> child, double value); |
Sho SHIMIZU | 1f5e591 | 2015-08-10 17:00:00 -0700 | [diff] [blame] | 107 | } |