View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.client;
20  
21  import org.apache.hadoop.classification.InterfaceAudience;
22  
23  /**
24   * NonceGenerator interface.
25   * In general, nonce group is an ID (one per client, or region+client, or whatever) that
26   * could be used to reduce collision potential, or be used by compatible server nonce manager
27   * to optimize nonce storage and removal. See HBASE-3787.
28   */
29  @InterfaceAudience.Private
30  public interface NonceGenerator {
31  
32    /** @return the nonce group (client ID) of this client manager. */
33    public long getNonceGroup();
34  
35    /** @return New nonce. */
36    public long newNonce();
37  }