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