Madan Jampani | 2546111 | 2015-02-17 14:17:29 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Madan Jampani | 2546111 | 2015-02-17 14:17:29 -0800 | [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 | */ |
| 16 | |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 17 | package org.onosproject.store.service; |
| 18 | |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 19 | import java.util.Arrays; |
| 20 | import java.util.List; |
| 21 | |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 22 | import org.onlab.util.KryoNamespace; |
| 23 | |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 24 | import com.google.common.collect.Lists; |
| 25 | |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 26 | /** |
Madan Jampani | 8098405 | 2015-07-23 13:11:36 -0700 | [diff] [blame] | 27 | * Interface for serialization of store artifacts. |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 28 | */ |
| 29 | public interface Serializer { |
| 30 | /** |
| 31 | * Serialize the specified object. |
| 32 | * @param object object to serialize. |
| 33 | * @return serialized bytes. |
| 34 | * @param <T> encoded type |
| 35 | */ |
| 36 | <T> byte[] encode(T object); |
| 37 | |
| 38 | /** |
| 39 | * Deserialize the specified bytes. |
| 40 | * @param bytes byte array to deserialize. |
| 41 | * @return deserialized object. |
| 42 | * @param <T> decoded type |
| 43 | */ |
| 44 | <T> T decode(byte[] bytes); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 45 | |
| 46 | /** |
Jordan Halterman | 2c83a10 | 2017-08-20 17:11:41 -0700 | [diff] [blame] | 47 | * Copies the specified object. |
| 48 | * @param object object to copy. |
| 49 | * @param <T> object type |
| 50 | * @return copied object |
| 51 | */ |
| 52 | <T> T copy(T object); |
| 53 | |
| 54 | /** |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 55 | * Creates a new Serializer instance from a KryoNamespace. |
| 56 | * |
| 57 | * @param kryo kryo namespace |
| 58 | * @return Serializer instance |
| 59 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 60 | static Serializer using(KryoNamespace kryo) { |
HIGUCHI Yuta | c299d07 | 2016-05-18 15:18:45 -0700 | [diff] [blame] | 61 | return new Serializer() { |
| 62 | |
| 63 | @Override |
| 64 | public <T> byte[] encode(T object) { |
| 65 | return kryo.serialize(object); |
| 66 | } |
| 67 | |
| 68 | @Override |
| 69 | public <T> T decode(byte[] bytes) { |
| 70 | return kryo.deserialize(bytes); |
| 71 | } |
Jordan Halterman | 2c83a10 | 2017-08-20 17:11:41 -0700 | [diff] [blame] | 72 | |
| 73 | @Override |
| 74 | public <T> T copy(T object) { |
| 75 | return kryo.run(k -> k.copy(object)); |
| 76 | } |
HIGUCHI Yuta | c299d07 | 2016-05-18 15:18:45 -0700 | [diff] [blame] | 77 | }; |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 78 | } |
| 79 | |
Madan Jampani | 17ed48b | 2015-12-09 10:56:35 -0800 | [diff] [blame] | 80 | /** |
| 81 | * Creates a new Serializer instance from a KryoNamespace and some additional classes. |
| 82 | * |
| 83 | * @param namespace kryo namespace |
| 84 | * @param classes variable length array of classes to register |
| 85 | * @return Serializer instance |
| 86 | */ |
| 87 | static Serializer using(KryoNamespace namespace, Class<?>... classes) { |
| 88 | return using(Arrays.asList(namespace), classes); |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Creates a new Serializer instance from a list of KryoNamespaces and some additional classes. |
| 93 | * |
| 94 | * @param namespaces kryo namespaces |
| 95 | * @param classes variable length array of classes to register |
| 96 | * @return Serializer instance |
| 97 | */ |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 98 | static Serializer using(List<KryoNamespace> namespaces, Class<?>... classes) { |
| 99 | KryoNamespace.Builder builder = new KryoNamespace.Builder(); |
| 100 | namespaces.forEach(builder::register); |
| 101 | Lists.newArrayList(classes).forEach(builder::register); |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 102 | KryoNamespace namespace = builder.build(); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 103 | return new Serializer() { |
| 104 | @Override |
| 105 | public <T> byte[] encode(T object) { |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 106 | return namespace.serialize(object); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | @Override |
| 110 | public <T> T decode(byte[] bytes) { |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 111 | return namespace.deserialize(bytes); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 112 | } |
Jordan Halterman | 2c83a10 | 2017-08-20 17:11:41 -0700 | [diff] [blame] | 113 | |
| 114 | @Override |
| 115 | public <T> T copy(T object) { |
| 116 | return namespace.run(kryo -> kryo.copy(object)); |
| 117 | } |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 118 | }; |
| 119 | } |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 120 | |
| 121 | static Serializer forTypes(Class<?>... classes) { |
| 122 | return using(KryoNamespace.newBuilder() |
| 123 | .register(classes) |
| 124 | .register(MapEvent.class, MapEvent.Type.class) |
| 125 | .build()); |
| 126 | } |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 127 | } |