blob: 8533cebc1e6c1ede8e086fd176efeddc275ba521 (
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
|
/*
* Copyright 2014-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.intent;
import com.google.common.annotations.Beta;
import org.onosproject.event.ListenerService;
import java.util.List;
/**
* Service for application submitting or withdrawing their intents.
*/
@Beta
public interface IntentService
extends ListenerService<IntentEvent, IntentListener> {
/**
* Submits an intent into the system.
* <p>
* This is an asynchronous request meaning that any compiling or
* installation activities may be done at later time.
* </p>
* @param intent intent to be submitted
*/
void submit(Intent intent);
/**
* Withdraws an intent from the system.
* <p>
* This is an asynchronous request meaning that the environment may be
* affected at later time.
* </p>
* @param intent intent to be withdrawn
*/
void withdraw(Intent intent);
/**
* Purges a specific intent from the system if it is <b>FAILED</b> or
* <b>WITHDRAWN</b>. Otherwise, the intent remains in its current state.
*
* @param intent intent to purge
*/
void purge(Intent intent);
/**
* Fetches an intent based on its key.
*
* @param key key of the intent
* @return intent object if the key is found, null otherwise
*/
Intent getIntent(Key key);
/**
* Returns an iterable of intents currently in the system.
*
* @return set of intents
*/
Iterable<Intent> getIntents();
/**
* Returns an iterable of intent data objects currently in the system.
*
* @return set of intent data objects
*/
Iterable<IntentData> getIntentData();
/**
* Returns the number of intents currently in the system.
*
* @return number of intents
*/
long getIntentCount();
/**
* Retrieves the state of an intent by its identifier.
*
* @param intentKey intent identifier
* @return the intent state or null if one with the given identifier is not
* found
*/
IntentState getIntentState(Key intentKey);
/**
* Returns the list of the installable events associated with the specified
* top-level intent.
*
* @param intentKey top-level intent identifier
* @return compiled installable intents
*/
List<Intent> getInstallableIntents(Key intentKey);
/**
* Signifies whether the local node is responsible for processing the given
* intent key.
*
* @param intentKey intent key to check
* @return true if the local node is responsible for the intent key,
* otherwise false
*/
boolean isLocal(Key intentKey);
/**
* Returns the list of intent requests pending processing.
*
* @return intents pending processing
*/
Iterable<Intent> getPending();
}
|
