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
|
/*
* 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.store.Store;
import java.util.List;
/**
* Manages inventory of end-station intents; not intended for direct use.
*/
@Beta
public interface IntentStore extends Store<IntentEvent, IntentStoreDelegate> {
/**
* Returns the number of intents in the store.
*
* @return the number of intents in the store
*/
long getIntentCount();
/**
* Returns an iterable of all intents in the store.
*
* @return iterable of all intents
*/
Iterable<Intent> getIntents();
/**
* Returns an iterable of all intent data objects in the store.
*
* @param localOnly should only intents for which this instance is master
* be returned
* @param olderThan specified duration in milliseconds (0 for "now")
* @return iterable of all intent data objects
*/
Iterable<IntentData> getIntentData(boolean localOnly, long olderThan);
/**
* Returns the state of the specified intent.
*
* @param intentKey intent identification
* @return current intent state
*/
IntentState getIntentState(Key intentKey);
/**
* Returns the list of the installable events associated with the specified
* original intent.
*
* @param intentKey original intent identifier
* @return compiled installable intents, or null if no installables exist
*/
List<Intent> getInstallableIntents(Key intentKey);
/**
* Writes an IntentData object to the store.
*
* @param newData new intent data to write
*/
void write(IntentData newData);
/**
* Writes a batch of IntentData objects to the store. A batch has no
* semantics, this is simply a convenience API.
*
* @param updates collection of intent data objects to write
*/
void batchWrite(Iterable<IntentData> updates);
/**
* Returns the intent with the specified identifier.
*
* @param key key
* @return intent or null if not found
*/
Intent getIntent(Key key);
/**
* Returns the intent data object associated with the specified key.
*
* @param key key to look up
* @return intent data object
*/
IntentData getIntentData(Key key);
/**
* Adds a new operation, which should be persisted and delegated.
*
* @param intent operation
*/
void addPending(IntentData intent);
/**
* Checks to see whether the calling instance is the master for processing
* this intent, or more specifically, the key contained in this intent.
*
* @param intentKey intentKey to check
* @return true if master; false, otherwise
*/
//TODO better name
boolean isMaster(Key intentKey);
/**
* Returns the intent requests pending processing.
*
* @return pending intents
*/
Iterable<Intent> getPending();
/**
* Returns the intent data objects that are pending processing.
*
* @return pending intent data objects
*/
Iterable<IntentData> getPendingData();
/**
* Returns the intent data objects that are pending processing for longer
* than the specified duration.
*
* @param localOnly should only intents for which this instance is master
* be returned
* @param olderThan specified duration in milliseconds (0 for "now")
* @return pending intent data objects
*/
Iterable<IntentData> getPendingData(boolean localOnly, long olderThan);
}
|
