blob: b1d73a7c71cf019a6e7e1d6b50f2c994dcafc116 (
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
|
/*
* 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.core.ApplicationId;
import java.util.Optional;
/**
* Base representation of a flow-objective description.
*/
@Beta
public interface Objective {
boolean DEFAULT_PERMANENT = true;
int DEFAULT_TIMEOUT = 0;
int DEFAULT_PRIORITY = 32768;
/**
* Type of operation.
*/
enum Operation {
/**
* Adds the objective. Can be used for any flow objective. For forwarding
* and filtering objectives, existing objectives with identical selector
* and priority fields (but different treatments or next) will be replaced.
* For next objectives, if modification is desired, ADD will not
* do anything - use ADD_TO_EXISTING.
*/
ADD,
/**
* Removes the objective. Can be used for any flow objective.
*/
REMOVE,
/**
* Add to an existing Next Objective. Should not be used for any other
* objective.
*/
ADD_TO_EXISTING,
/**
* Remove from an existing Next Objective. Should not be used for any
* other objective.
*/
REMOVE_FROM_EXISTING
}
/**
* An identifier for this objective.
*
* @return an integer
*/
int id();
/**
* The priority for this objective.
*
* @return an integer
*/
int priority();
/**
* The application which applied this objective.
*
* @return an application id
*/
ApplicationId appId();
/**
* The timeout for this objective.
*
* @return an integer
*/
int timeout();
/**
* Whether this objective is permanent.
*
* @return a boolean
*/
boolean permanent();
/**
* The type of operation for this objective.
*
* @return an operation
*/
Operation op();
/**
* Obtains an optional context.
*
* @return optional; which will be empty if there is no context.
* Otherwise it will return the context.
*/
Optional<ObjectiveContext> context();
/**
* An objective builder.
*/
interface Builder {
/**
* Makes the filtering objective temporary.
*
* @param timeout a timeout
* @return an objective builder
*/
Builder makeTemporary(int timeout);
/**
* Makes the filtering objective permanent.
*
* @return an objective builder
*/
Builder makePermanent();
/**
* Specifies the application which applied the filter.
*
* @param appId an application id
* @return an objective builder
*/
Builder fromApp(ApplicationId appId);
/**
* Sets the priority for this objective.
*
* @param priority an integer
* @return an objective builder
*/
Builder withPriority(int priority);
}
}
|
