blob: 9857a7105db4b6f4f4ace81d30e8814d23f788ed (
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*
* 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.net.flowobjective;
import com.google.common.annotations.Beta;
import org.onosproject.net.flow.TrafficSelector;
import org.onosproject.net.flow.TrafficTreatment;
/**
* Represents a description of which types of traffic need to
* be forwarded through the device. A forwarding objective may
* result in multiple rules at the device. There are two main types
* of forwarding objectives:
*
* - Versatile
* - Specific
*
* A versatile forwarding objective represents a composite rule that matches
* two or more header fields. The use of versatile usually indicates that this
* rule should be inserted in its entirety into the ACL table. Although,
* drivers for some devices are free to implement this differently.
*
* A specific forwarding objective represents a specific rule matching one or
* more header fields. The installation of this rule may result in several rules
* at the device. For example, one per table type.
*/
@Beta
public interface ForwardingObjective extends Objective {
/**
* Represents whether this objective is monolithic or
* may be broken down into parts.
*/
enum Flag {
/**
* A decomposable objective.
*/
SPECIFIC,
/**
* A monolithic objective.
*/
VERSATILE
}
/**
* Obtain the selector for this objective.
*
* @return a traffic selector
*/
TrafficSelector selector();
/**
* Obtain the traffic treatment for this objective. Mutually exclusive with
* 'treatment'.
*
* @return an integer
*/
Integer nextId();
/**
* A traffic treatment for this forwarding objective. Mutually exclusive
* with a nextId.
*
* @return a traffic treatment
*/
TrafficTreatment treatment();
/**
* Obtain the type of this objective.
*
* @return a flag type
*/
Flag flag();
/**
* A forwarding objective builder.
*/
interface Builder extends Objective.Builder {
/**
* Assigns a selector to the forwarding objective.
*
* @param selector a traffic selector
* @return a forwarding objective builder
*/
Builder withSelector(TrafficSelector selector);
/**
* Assigns a next step to the forwarding objective.
*
* @param nextId a next objective id.
* @return a forwarding objective builder
*/
Builder nextStep(int nextId);
/**
* Assigns the treatment for this forwarding objective.
*
* @param treatment a traffic treatment
* @return a forwarding objective
*/
Builder withTreatment(TrafficTreatment treatment);
/**
* Assigns the flag to the forwarding objective.
*
* @param flag a flag
* @return a forwarding objective builder
*/
Builder withFlag(Flag flag);
/**
* Builds the forwarding objective that will be added.
*
* @return a forwarding objective
*/
ForwardingObjective add();
/**
* Builds the forwarding objective that will be removed.
*
* @return a forwarding objective.
*/
ForwardingObjective remove();
/**
* Builds the forwarding objective that will be added.
* The context will be used to notify the calling application.
*
* @param context an objective context
* @return a forwarding objective
*/
ForwardingObjective add(ObjectiveContext context);
/**
* Builds the forwarding objective that will be removed.
* The context will be used to notify the calling application.
*
* @param context an objective context
* @return a forwarding objective
*/
ForwardingObjective remove(ObjectiveContext context);
}
}
|
