blob: f6285e6128f0a2b4af2740920825f8ceebf7ba61 (
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
139
|
/*
* 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;
/**
* Abstraction of an entity providing Port Pair information.
* A port pair represents a service function instance.
*/
public interface PortPair {
/**
* Returns the ID of this port Pair.
*
* @return the port pair id
*/
PortPairId portPairId();
/**
* Returns the tenant id of this port pair.
*
* @return an tenant id
*/
TenantId tenantId();
/**
* Returns the description of this port pair.
*
* @return description of port pair
*/
String name();
/**
* Returns the description of this port pair.
*
* @return description of port pair
*/
String description();
/**
* Returns the ingress port of this port pair.
*
* @return ingress of port pair
*/
String ingress();
/**
* Returns the egress port of this port pair.
*
* @return egress of port pair
*/
String egress();
/**
* Returns whether this port pair is an exact match to the port pair given
* in the argument.
* <p>
* Exact match means the Port port pairs match with the given port pair.
* It does not consider the port pair id, name and description.
* </p>
* @param portPair other port pair to match against
* @return true if the port pairs are an exact match, otherwise false
*/
boolean exactMatch(PortPair portPair);
/**
* A port pair builder..
*/
interface Builder {
/**
* Assigns the port pair id to this object.
*
* @param portPairId the port pair id
* @return this the builder object
*/
Builder setId(PortPairId portPairId);
/**
* Assigns tenant id to this object.
*
* @param tenantId tenant id of the port pair
* @return this the builder object
*/
Builder setTenantId(TenantId tenantId);
/**
* Assigns the name to this object.
*
* @param name name of the port pair
* @return this the builder object
*/
Builder setName(String name);
/**
* Assigns the description to this object.
*
* @param description description of the port pair
* @return this the builder object
*/
Builder setDescription(String description);
/**
* Assigns the ingress port to this object.
*
* @param port ingress port of the port pair
* @return this the builder object
*/
Builder setIngress(String port);
/**
* Assigns the egress port to this object.
*
* @param port egress port of the port pair
* @return this the builder object
*/
Builder setEgress(String port);
/**
* Builds a port pair object.
*
* @return a port pair.
*/
PortPair build();
}
}
|
