EdColeman commented on a change in pull request #2569: URL: https://github.com/apache/accumulo/pull/2569#discussion_r829246528
########## File path: server/base/src/main/java/org/apache/accumulo/server/conf/store/PropCacheId.java ########## @@ -0,0 +1,278 @@ +/* + * 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.store; + +import static org.apache.accumulo.core.Constants.ZCONFIG; +import static org.apache.accumulo.core.Constants.ZNAMESPACES; +import static org.apache.accumulo.core.Constants.ZNAMESPACE_CONF; +import static org.apache.accumulo.core.Constants.ZTABLES; +import static org.apache.accumulo.core.Constants.ZTABLE_CONF; + +import java.util.Comparator; +import java.util.Objects; +import java.util.Optional; +import java.util.StringJoiner; + +import org.apache.accumulo.core.data.InstanceId; +import org.apache.accumulo.core.data.NamespaceId; +import org.apache.accumulo.core.data.TableId; +import org.apache.accumulo.fate.zookeeper.ZooUtil; +import org.apache.accumulo.server.ServerContext; +import org.checkerframework.checker.nullness.qual.NonNull; + +/** + * Provides a strongly-typed id for storing properties in ZooKeeper. The path in ZooKeeper is + * determined by the instance id and the type (system, namespace and table), with different root + * paths. + * <p> + * Provides utility methods from constructing different id based on type and methods to parse a + * ZooKeeper path and return a prop cache id. + */ +public class PropCacheId implements Comparable<PropCacheId> { + + public static final String PROP_NODE_NAME = "encoded_props"; + + // indices for path.split(); + public static final int TYPE_TOKEN_POSITION = 3; + public static final int IID_TOKEN_POSITION = 2; + public static final int ID_TOKEN_POSITION = 4; + + // remove starting slash from constant. + public static final String TABLES_NODE_NAME = ZTABLES.substring(1); + public static final String NAMESPACE_NODE_NAME = ZNAMESPACES.substring(1); + + private final String path; + private final IdType idType; + private final NamespaceId namespaceId; + private final TableId tableId; + + private PropCacheId(final String path, final IdType idType, final NamespaceId namespaceId, + final TableId tableId) { + this.path = path; + this.idType = idType; + this.namespaceId = namespaceId; + this.tableId = tableId; + } + + /** + * Instantiate a system prop cache id using the instance id from the context. + * + * @param context + * the system context specifying the instance id + * @return a prop cache id for system properties, + */ + public static PropCacheId forSystem(final ServerContext context) { + return forSystem(context.getInstanceID()); + } + + /** + * Instantiate a system prop cache id. + * + * @param instanceId + * the instance id. + * @return a prop cache id for system properties, + */ + public static PropCacheId forSystem(final InstanceId instanceId) { + return new PropCacheId(ZooUtil.getRoot(instanceId) + ZCONFIG + "/" + PROP_NODE_NAME, + IdType.SYSTEM, null, null); + } + + /** + * Instantiate a namespace prop cache id using the instance id from the context. + * + * @param context + * the system context specifying the instance id + * @param namespaceId + * the namespace id + * @return a prop cache id a namespaces properties, + */ + public static PropCacheId forNamespace(final ServerContext context, + final NamespaceId namespaceId) { + return forNamespace(context.getInstanceID(), namespaceId); + } + + /** + * Instantiate a namespace prop cache id using the instance id from the context. + * + * @param instanceId + * the instance id + * @param namespaceId + * the namespace id + * @return a prop cache id a namespaces properties, + */ + public static PropCacheId forNamespace(final InstanceId instanceId, + final NamespaceId namespaceId) { + return new PropCacheId(ZooUtil.getRoot(instanceId) + ZNAMESPACES + "/" + namespaceId.canonical() + + ZNAMESPACE_CONF + "/" + PROP_NODE_NAME, IdType.NAMESPACE, namespaceId, null); + } + + /** + * Instantiate a namespace prop cache id using the instance id from the context. + * + * @param context + * the system context specifying the instance id + * @param tableId + * the table id + * @return a prop cache id a namespaces properties, + */ + public static PropCacheId forTable(final ServerContext context, final TableId tableId) { + return forTable(context.getInstanceID(), tableId); + } + + /** + * Instantiate a namespace prop cache id using the instance id from the context. + * + * @param instanceId + * the instance id + * @param tableId + * the table id + * @return a prop cache id a namespaces properties, + */ + public static PropCacheId forTable(final InstanceId instanceId, final TableId tableId) { + return new PropCacheId(ZooUtil.getRoot(instanceId) + ZTABLES + "/" + tableId.canonical() + + ZTABLE_CONF + "/" + PROP_NODE_NAME, IdType.TABLE, null, tableId); + } + + /** + * Determine the prop cache id from a ZooKeeper path + * + * @param path + * the path + * @return the prop cache id + */ + public static Optional<PropCacheId> fromPath(final String path) { + String[] tokens = path.split("/"); + Review comment: Fixed in 6df9f23cf9 -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
