summaryrefslogtreecommitdiffstats
path: root/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/domain/IntentResource.java
blob: 627c863f93bdbc17c005ced777eea692e22de174 (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
/*
 * Copyright 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.incubator.net.domain;

import com.google.common.annotations.Beta;
import org.onosproject.core.ApplicationId;
import org.onosproject.net.ConnectPoint;


/**
 * The abstract base class for the resource that satisfies an intent primitive.
 */
@Beta
public abstract class IntentResource {

    private final IntentPrimitive primitive;

    private final ApplicationId appId;
    private final ConnectPoint ingress;
    private final ConnectPoint egress;

    //* QUESTIONABLE ADDITIONS *//

    // TODO add other common fields
    //String ingressTag;
    //String egressTag;
    //etc.

    public IntentResource(IntentPrimitive primitive, ApplicationId appId,
                          ConnectPoint ingress, ConnectPoint egress) {
        this.appId = appId;
        this.ingress = ingress;
        this.egress = egress;
        this.primitive = primitive;
    }

    //TODO when is same package tunnelID should be of type tunnelID and netTunnelId not long.


    /**
     * Returns the intent primitive associated with this resource at creation.
     *
     * @return this resource's intent primitive.
     */
    public IntentPrimitive primitive() {
        return primitive;
    }

    /**
     * Returns the application ID associated with this resource at creation.
     *
     * @return this resource's application ID.
     */
    public ApplicationId appId() {
        return appId;
    }

    /**
     * Returns the ingress connect point associated with this resource at creation.
     *
     * @return this resource's ingress connect point.
     */
    public ConnectPoint ingress() {
        return ingress;
    }

    /**
     * Returns the egress connect point associated with this resource at creation.
     *
     * @return this resource's connect point.
     */
    public ConnectPoint egress() {
        return egress;
    }
}