001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022/**
023 * NonceGenerator interface. In general, nonce group is an ID (one per client, or region+client, or
024 * whatever) that could be used to reduce collision potential, or be used by compatible server nonce
025 * manager to optimize nonce storage and removal. See HBASE-3787.
026 */
027@InterfaceAudience.Private
028public interface NonceGenerator {
029
030  static final String CLIENT_NONCES_ENABLED_KEY = "hbase.client.nonces.enabled";
031
032  /** Returns the nonce group (client ID) of this client manager. */
033  long getNonceGroup();
034
035  /** Returns New nonce. */
036  long newNonce();
037}