Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Laboratory |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store; |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.event.Event; |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 19 | |
| 20 | /** |
| 21 | * Abstraction of a entity capable of storing and/or distributing information |
| 22 | * across a cluster. |
| 23 | */ |
| 24 | public interface Store<E extends Event, D extends StoreDelegate<E>> { |
| 25 | |
| 26 | /** |
| 27 | * Sets the delegate on the store. |
| 28 | * |
| 29 | * @param delegate new store delegate |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 30 | * @throws java.lang.IllegalStateException if a delegate is already |
| 31 | * currently set on the store and is a different one that |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 32 | */ |
| 33 | void setDelegate(D delegate); |
| 34 | |
| 35 | /** |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 36 | * Withdraws the delegate from the store. |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 37 | * |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 38 | * @param delegate store delegate to withdraw |
| 39 | * @throws java.lang.IllegalArgumentException if the delegate is not |
| 40 | * currently set on the store |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 41 | */ |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 42 | void unsetDelegate(D delegate); |
| 43 | |
| 44 | /** |
| 45 | * Indicates whether the store has a delegate. |
| 46 | * |
| 47 | * @return true if delegate is set |
| 48 | */ |
| 49 | boolean hasDelegate(); |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 50 | |
| 51 | } |