1 /* Copyright (c) 2016, 2021, Oracle and/or its affiliates. 2 3 This program is free software; you can redistribute it and/or modify 4 it under the terms of the GNU General Public License, version 2.0, 5 as published by the Free Software Foundation. 6 7 This program is also distributed with certain software (including 8 but not limited to OpenSSL) that is licensed under separate terms, 9 as designated in a particular file or component or in included license 10 documentation. The authors of MySQL hereby grant you an additional 11 permission to link the program and your derivative works with the 12 separately licensed software that they have included with MySQL. 13 14 This program is distributed in the hope that it will be useful, 15 but WITHOUT ANY WARRANTY; without even the implied warranty of 16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 GNU General Public License, version 2.0, for more details. 18 19 You should have received a copy of the GNU General Public License 20 along with this program; if not, write to the Free Software 21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ 22 23 #ifndef MYSQL_I_SERIALIZER_H 24 #define MYSQL_I_SERIALIZER_H 25 26 #include <my_global.h> 27 #include <hash.h> 28 #include "i_serialized_object.h" 29 30 namespace keyring 31 { 32 33 class ISerializer 34 { 35 public: 36 /** 37 * Purpose of this function is to serialize keys_hash or key (or both) 38 * into an object implementing ISeriazlized_object interface. 39 * @param keys_hash - HASH container of all the keys stored in keyring. 40 * This parameter is usually used when all the keys 41 * need to be serialized. 42 * @param key - key to be added or removed. 43 * @param operation - The operation which is performed on key. It shows 44 * whether we serialize key that is to be removed or 45 * stored. 46 * @return ISerialized_object on success returns serialized object, ie. object 47 * which implements ISeriazlied_object interface 48 * on failure returns NULL. 49 */ 50 virtual ISerialized_object* serialize(HASH *keys_hash, IKey *key, 51 Key_operation operation)= 0; ~ISerializer()52 virtual ~ISerializer() 53 {} 54 }; 55 } //namespace keyring 56 57 #endif //MYSQL_I_SERIALIZER_H 58