aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/net/resource/link/LinkResourceRequest.java
blob: 9774e8e7acc8e05a5b3bd2be60cf7aaa437f1430 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Copyright 2014-2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.net.resource.link;

import java.util.Collection;
import java.util.Map;
import java.util.Set;

import com.google.common.annotations.Beta;
import org.onosproject.net.Link;
import org.onosproject.net.intent.Constraint;
import org.onosproject.net.intent.IntentId;
import org.onosproject.net.resource.ResourceRequest;

/**
 * Representation of a request for link resource.
 *
 * @deprecated in Emu Release
 */
@Deprecated
public interface LinkResourceRequest extends ResourceRequest {

    /**
     * Returns the {@link IntentId} associated with the request.
     *
     * @return the {@link IntentId} associated with the request
     */
    IntentId intentId();

    /**
     * Returns the set of target links.
     *
     * @return the set of target links
     */
    Collection<Link> links();

    /**
     * Returns the set of resource requests.
     *
     * @return the set of resource requests
     */
    Set<ResourceRequest> resources();

    /**
     * Returns the set of resource request against the specified link.
     *
     * @param link link whose associated resource request is to be returned
     * @return set of resource request against the specified link
     */
    @Beta
    Set<ResourceRequest> resources(Link link);

    /**
     * Builder of link resource request.
     */
    interface Builder {
        /**
         * Adds lambda request.
         *
         * @return self
         * @deprecated in Emu Release
         */
        @Deprecated
        Builder addLambdaRequest();

        /**
         * Adds lambda request.
         *
         * @param lambda lambda to be requested
         * @return self
         */
        @Beta
        Builder addLambdaRequest(LambdaResource lambda);

        /**
         * Adds MPLS request.
         *
         * @return self
         * @deprecated in Emu Release
         */
        @Deprecated
        Builder addMplsRequest();

        /**
         * Adds MPLS request.
         *
         * @param label MPLS label to be requested
         * @return self
         */
        @Beta
        Builder addMplsRequest(MplsLabel label);

        /**
         * Adds MPLS request against the specified links.
         *
         * @param labels MPLS labels to be requested against links
         * @return self
         */
        @Beta
        Builder addMplsRequest(Map<Link, MplsLabel> labels);

        /**
         * Adds bandwidth request with bandwidth value.
         *
         * @param bandwidth bandwidth value to be requested
         * @return self
         */
        Builder addBandwidthRequest(double bandwidth);

        /**
         * Adds the resources required for a constraint.
         *
         * @param constraint the constraint
         * @return self
         */
        Builder addConstraint(Constraint constraint);

        /**
         * Returns link resource request.
         *
         * @return link resource request
         */
        LinkResourceRequest build();
    }
}