summaryrefslogtreecommitdiffstats
path: root/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/TenantNetwork.java
blob: 256352f404083dbb83e5e6aa1274a026e353ec51 (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
/*
 * 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.vtnrsc;

/**
 * Representation of the tenantNetwork.
 */
public interface TenantNetwork {

    /**
     * Coarse classification of the state of the tenantNetwork.
     */
    enum State {
        /**
         * Signifies that a tenantNetwork is currently active.This state means
         * that this network is available.
         */
        ACTIVE,
        /**
         * Signifies that a tenantNetwork is currently built.
         */
        BUILD,
        /**
         * Signifies that a tenantNetwork is currently unavailable.
         */
        DOWN,
        /**
         * Signifies that a tenantNetwork is currently error.
         */
        ERROR
    }

    /**
     * Coarse classification of the type of the tenantNetwork.
     */
    enum Type {
        /**
         * Signifies that a tenantNetwork is local.
         */
        LOCAL
    }

    /**
     * Returns the tenantNetwork identifier.
     *
     * @return tenantNetwork identifier
     */
    TenantNetworkId id();

    /**
     * Returns the tenantNetwork name.
     *
     * @return tenantNetwork name
     */
    String name();

    /**
     * Returns the administrative state of the tenantNetwork,which is up(true)
     * or down(false).
     *
     * @return true or false
     */
    boolean adminStateUp();

    /**
     * Returns the tenantNetwork state.
     *
     * @return tenant network state
     */
    State state();

    /**
     * Indicates whether this tenantNetwork is shared across all tenants. By
     * default,only administrative user can change this value.
     *
     * @return true or false
     */
    boolean shared();

    /**
     * Returns the UUID of the tenant that will own the tenantNetwork. This
     * tenant can be different from the tenant that makes the create
     * tenantNetwork request.
     *
     * @return the tenant identifier
     */
    TenantId tenantId();

    /**
     * Returns the routerExternal.Indicates whether this network is externally
     * accessible.
     *
     * @return true or false
     */
    boolean routerExternal();

    /**
     * Returns the tenantNetwork Type.
     *
     * @return tenantNetwork Type
     */
    Type type();

    /**
     * Returns the tenantNetwork physical network.
     *
     * @return tenantNetwork physical network
     */
    PhysicalNetwork physicalNetwork();

    /**
     * Returns the tenantNetwork segmentation id.
     *
     * @return tenantNetwork segmentation id
     */
    SegmentationId segmentationId();
}