| Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Foundation |
| 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 | */ |
| 16 | package org.onosproject.store.service; |
| 17 | |
| 18 | import com.google.common.annotations.Beta; |
| 19 | |
| 20 | /** |
| 21 | * Cross-version storage/coordination service. |
| 22 | * <p> |
| 23 | * This is a special type of {@link PrimitiveService} that differs semantically from {@link StorageService} in that |
| 24 | * it supports cross-version backward/forward compatible storage. During upgrades, when nodes are running different |
| 25 | * versions of the software, this service guarantees that cross-version compatibility will be maintained and provides |
| 26 | * shared compatible primitives for coordinating across versions. Users must ensure that all objects stored in |
| 27 | * primitives created via this service are stored using a serialization format that is backward/forward compatible, |
| 28 | * e.g. using {@link org.onlab.util.KryoNamespace.Builder#setCompatible(boolean)}. |
| 29 | * |
| 30 | * @see org.onlab.util.KryoNamespace.Builder#setCompatible(boolean) |
| 31 | * @see StorageService |
| 32 | */ |
| 33 | @Beta |
| 34 | public interface CoordinationService extends PrimitiveService { |
| 35 | } |