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 java.util.ArrayList;
22  import java.util.Arrays;
23  import java.util.List;
24  import java.util.Map;
25  import java.util.Set;
26  import java.util.TreeMap;
27  
28  import org.apache.hadoop.hbase.HConstants;
29  import org.apache.hadoop.hbase.classification.InterfaceAudience;
30  import org.apache.hadoop.hbase.util.Bytes;
31  
32  /**
33   * Container for Actions (i.e. Get, Delete, or Put), which are grouped by
34   * regionName. Intended to be used with HConnectionManager.processBatch()
35   */
36  @InterfaceAudience.Private
37  public final class MultiAction<R> {
38    // TODO: This class should not be visible outside of the client package.
39  
40    // map of regions to lists of puts/gets/deletes for that region.
41    protected Map<byte[], List<Action<R>>> actions = new TreeMap<>(Bytes.BYTES_COMPARATOR);
42  
43    private long nonceGroup = HConstants.NO_NONCE;
44  
45    public MultiAction() {
46      super();
47    }
48  
49    /**
50     * Get the total number of Actions
51     *
52     * @return total number of Actions for all groups in this container.
53     */
54    public int size() {
55      int size = 0;
56      for (List<?> l : actions.values()) {
57        size += l.size();
58      }
59      return size;
60    }
61  
62    /**
63     * Add an Action to this container based on it's regionName. If the regionName
64     * is wrong, the initial execution will fail, but will be automatically
65     * retried after looking up the correct region.
66     *
67     * @param regionName
68     * @param a
69     */
70    public void add(byte[] regionName, Action<R> a) {
71      add(regionName, Arrays.asList(a));
72    }
73  
74    /**
75     * Add an Action to this container based on it's regionName. If the regionName
76     * is wrong, the initial execution will fail, but will be automatically
77     * retried after looking up the correct region.
78     *
79     * @param regionName
80     * @param actionList list of actions to add for the region
81     */
82    public void add(byte[] regionName, List<Action<R>> actionList){
83      List<Action<R>> rsActions = actions.get(regionName);
84      if (rsActions == null) {
85        rsActions = new ArrayList<Action<R>>(actionList.size());
86        actions.put(regionName, rsActions);
87      }
88      rsActions.addAll(actionList);
89    }
90  
91    public void setNonceGroup(long nonceGroup) {
92      this.nonceGroup = nonceGroup;
93    }
94  
95    public Set<byte[]> getRegions() {
96      return actions.keySet();
97    }
98  
99    public boolean hasNonceGroup() {
100     return nonceGroup != HConstants.NO_NONCE;
101   }
102 
103   public long getNonceGroup() {
104     return this.nonceGroup;
105   }
106 }