[GitHub] [accumulo] dlmarion commented on a change in pull request #2194: Serialization of a map of key, value pairs map to / from byte array.

[GitBox <gi...@apache.org>]

dlmarion commented on a change in pull request #2194:
URL: https://github.com/apache/accumulo/pull/2194#discussion_r676528269



##########
File path: server/base/src/main/java/org/apache/accumulo/server/conf/codec/PropEncoding.java
##########
@@ -0,0 +1,120 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.accumulo.server.conf.codec;
+
+import java.time.Instant;
+import java.util.Map;
+
+public interface PropEncoding {
+
+  /**
+   * Add a property. If the property already exists it is overwritten.
+   *
+   * @param key
+   *          the name of the property
+   * @param value
+   *          the value of the property.
+   */
+  void addProperty(String key, String value);
+
+  /**
+   * Add multiple properties. If a property already exists it is overwritten.
+   *
+   * @param properties
+   *          A map of key, value pairs.
+   */
+  void addProperties(Map<String,String> properties);
+
+  /**
+   * Get a store property or null if it does not exist.
+   *
+   * @param key
+   *          the name of the property.
+   * @return the property value.
+   */
+  String getProperty(String key);
+
+  /**
+   * Delete a property.
+   *
+   * @param key
+   *          the name of the property.
+   * @return the previous value if the property was present.
+   */
+  String removeProperty(String key);
+
+  /**
+   * Properties are timestamped when the properties are serialized for storage. This is to allow
+   * easy comparison of properties that could have been retrieved at different times.
+   *
+   * @return the timestamp when the properties were serialized.
+   */
+  Instant getTimestamp();
+
+  /**
+   * Properties are store with a data version for serialization. This allows for comparison of
+   * properties and can be used to ensure that vales being written to the backend store have not
+   * changed. The data version is incremented when serialized with toBytes() so that the instance
+   * value is consistent with the store value.
+   *
+   * @return the data version when the properties were serialized.
+   */
+  int getDataVersion();
+
+  /**
+   * The version is incremented with a call to toBytes() - this method returns the value that should
+   * reflect the current version in the backing store. The expected usage is that the properties
+   * will be serialized into a byte array with a call {@link #toBytes()} - that will increment the
+   * data version - then, the {@link #getExpectedVersion()} will reflect the value that is currently
+   * in zookeeper and is the value passed to the zookeeper setData methods.
+   *
+   * @return the expected version current in the backend store.
+   */
+  int getExpectedVersion();
+
+  /**
+   * Serialize the version information and the properties.
+   *
+   * @return an array of bytes for storage.
+   */
+  byte[] toBytes();
+
+  /**
+   * Provide user-friend display string.
+   *
+   * @param prettyPrint
+   *          if true, insert new lines to improve readability.
+   * @return a formatted string, with optional new lines.
+   */
+  String print(boolean prettyPrint);
+
+  /**
+   * Get an unmodifiable map with all of the property, values.
+   *
+   * @return An unmodifiable view of the property key, values.
+   */
+  Map<String,String> getAllProperties();
+
+  /**
+   * Determine if the stage of the props is compressed or not.

Review comment:
       Did you mean `state` instead of `stage`?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org