| /* |
| * Copyright 2014 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 org.onosproject.net.intent.BatchWrite.Operation; |
| import org.onosproject.store.Store; |
| |
| import java.util.List; |
| |
| /** |
| * Manages inventory of end-station intents; not intended for direct use. |
| */ |
| 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 a collection of all intents in the store. |
| * |
| * @return iterable collection of all intents |
| */ |
| Iterable<Intent> getIntents(); |
| |
| /** |
| * Returns the intent with the specified identifier. |
| * |
| * @param intentId intent identification |
| * @return intent or null if not found |
| */ |
| Intent getIntent(IntentId intentId); |
| |
| /** |
| * Returns the state of the specified intent. |
| * |
| * @param intentId intent identification |
| * @return current intent state |
| */ |
| IntentState getIntentState(IntentId intentId); |
| |
| /** |
| * Returns the list of the installable events associated with the specified |
| * original intent. |
| * |
| * @param intentId original intent identifier |
| * @return compiled installable intents |
| */ |
| List<Intent> getInstallableIntents(IntentId intentId); |
| |
| /** |
| * Execute writes in a batch. |
| * If the specified BatchWrite is empty, write will not be executed. |
| * |
| * @param batch BatchWrite to execute |
| * @return failed operations |
| */ |
| List<Operation> batchWrite(BatchWrite batch); |
| |
| /** |
| * Adds a new operation, which should be persisted and delegated. |
| * |
| * @param op operation |
| */ |
| default void add(IntentOperation op) {} //FIXME remove when impl. |
| |
| /** |
| * Checks to see whether the calling instance is the master for processing |
| * this intent, or more specifically, the key contained in this intent. |
| * |
| * @param intent intent to check |
| * @return true if master; false, otherwise |
| */ |
| //TODO better name |
| default boolean isMaster(Intent intent) { //FIXME remove default when impl. |
| return true; |
| } |
| } |