View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.protobuf;
19  
20  import java.io.IOException;
21  import java.util.List;
22  
23  import org.apache.hadoop.classification.InterfaceAudience;
24  import org.apache.hadoop.hbase.CellScannable;
25  import org.apache.hadoop.hbase.DoNotRetryIOException;
26  import org.apache.hadoop.hbase.HColumnDescriptor;
27  import org.apache.hadoop.hbase.HRegionInfo;
28  import org.apache.hadoop.hbase.HTableDescriptor;
29  import org.apache.hadoop.hbase.ServerName;
30  import org.apache.hadoop.hbase.TableName;
31  import org.apache.hadoop.hbase.client.Action;
32  import org.apache.hadoop.hbase.client.Append;
33  import org.apache.hadoop.hbase.client.Delete;
34  import org.apache.hadoop.hbase.client.Durability;
35  import org.apache.hadoop.hbase.client.Get;
36  import org.apache.hadoop.hbase.client.Increment;
37  import org.apache.hadoop.hbase.client.Mutation;
38  import org.apache.hadoop.hbase.client.Put;
39  import org.apache.hadoop.hbase.client.Row;
40  import org.apache.hadoop.hbase.client.RowMutations;
41  import org.apache.hadoop.hbase.client.Scan;
42  import org.apache.hadoop.hbase.exceptions.DeserializationException;
43  import org.apache.hadoop.hbase.filter.ByteArrayComparable;
44  import org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos;
45  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CloseRegionRequest;
46  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CompactRegionRequest;
47  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.FlushRegionRequest;
48  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionRequest;
49  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoRequest;
50  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoRequest;
51  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetStoreFileRequest;
52  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.MergeRegionsRequest;
53  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionRequest;
54  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionRequest.RegionOpenInfo;
55  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterRequest;
56  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.SplitRegionRequest;
57  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.StopServerRequest;
58  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateFavoredNodesRequest;
59  import org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateFavoredNodesRequest.RegionUpdateInfo;
60  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos;
61  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.BulkLoadHFileRequest;
62  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.BulkLoadHFileRequest.FamilyPath;
63  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Column;
64  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Condition;
65  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetRequest;
66  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateRequest;
67  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto;
68  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.ColumnValue;
69  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.ColumnValue.QualifierValue;
70  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.MutationType;
71  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionAction;
72  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest;
73  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.CompareType;
74  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier;
75  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier.RegionSpecifierType;
76  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.AddColumnRequest;
77  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.AssignRegionRequest;
78  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.BalanceRequest;
79  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.CreateTableRequest;
80  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.DeleteColumnRequest;
81  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.DeleteTableRequest;
82  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.DisableTableRequest;
83  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.DispatchMergingRegionsRequest;
84  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.EnableCatalogJanitorRequest;
85  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.EnableTableRequest;
86  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.GetClusterStatusRequest;
87  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.GetSchemaAlterStatusRequest;
88  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.GetTableDescriptorsRequest;
89  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.IsCatalogJanitorEnabledRequest;
90  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.IsMasterRunningRequest;
91  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.ModifyColumnRequest;
92  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.ModifyTableRequest;
93  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.MoveRegionRequest;
94  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.OfflineRegionRequest;
95  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.RunCatalogScanRequest;
96  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetBalancerRunningRequest;
97  import org.apache.hadoop.hbase.protobuf.generated.MasterProtos.UnassignRegionRequest;
98  import org.apache.hadoop.hbase.protobuf.generated.RegionServerStatusProtos.GetLastFlushedSequenceIdRequest;
99  import org.apache.hadoop.hbase.util.Bytes;
100 import org.apache.hadoop.hbase.util.Pair;
101 import org.apache.hadoop.hbase.util.Triple;
102 
103 import com.google.protobuf.ByteString;
104 import com.google.protobuf.ZeroCopyLiteralByteString;
105 
106 /**
107  * Helper utility to build protocol buffer requests,
108  * or build components for protocol buffer requests.
109  */
110 @InterfaceAudience.Private
111 public final class RequestConverter {
112 
113   private RequestConverter() {
114   }
115 
116 // Start utilities for Client
117 
118 /**
119    * Create a new protocol buffer GetRequest to get a row, all columns in a family.
120    * If there is no such row, return the closest row before it.
121    *
122    * @param regionName the name of the region to get
123    * @param row the row to get
124    * @param family the column family to get
125    * should return the immediate row before
126    * @return a protocol buffer GetReuqest
127    */
128   public static GetRequest buildGetRowOrBeforeRequest(
129       final byte[] regionName, final byte[] row, final byte[] family) {
130     GetRequest.Builder builder = GetRequest.newBuilder();
131     RegionSpecifier region = buildRegionSpecifier(
132       RegionSpecifierType.REGION_NAME, regionName);
133     builder.setRegion(region);
134 
135     Column.Builder columnBuilder = Column.newBuilder();
136     columnBuilder.setFamily(ZeroCopyLiteralByteString.wrap(family));
137     ClientProtos.Get.Builder getBuilder =
138       ClientProtos.Get.newBuilder();
139     getBuilder.setRow(ZeroCopyLiteralByteString.wrap(row));
140     getBuilder.addColumn(columnBuilder.build());
141     getBuilder.setClosestRowBefore(true);
142     builder.setGet(getBuilder.build());
143     return builder.build();
144   }
145 
146 
147   /**
148    * Create a protocol buffer GetRequest for a client Get
149    *
150    * @param regionName the name of the region to get
151    * @param get the client Get
152    * @return a protocol buffer GetRequest
153    */
154   public static GetRequest buildGetRequest(final byte[] regionName,
155       final Get get) throws IOException {
156     GetRequest.Builder builder = GetRequest.newBuilder();
157     RegionSpecifier region = buildRegionSpecifier(
158       RegionSpecifierType.REGION_NAME, regionName);
159     builder.setRegion(region);
160     builder.setGet(ProtobufUtil.toGet(get));
161     return builder.build();
162   }
163 
164   /**
165    * Create a protocol buffer MutateRequest for a client increment
166    *
167    * @param regionName
168    * @param row
169    * @param family
170    * @param qualifier
171    * @param amount
172    * @param durability
173    * @return a mutate request
174    */
175   public static MutateRequest buildMutateRequest(
176       final byte[] regionName, final byte[] row, final byte[] family,
177       final byte [] qualifier, final long amount, final Durability durability) {
178     MutateRequest.Builder builder = MutateRequest.newBuilder();
179     RegionSpecifier region = buildRegionSpecifier(
180       RegionSpecifierType.REGION_NAME, regionName);
181     builder.setRegion(region);
182 
183     MutationProto.Builder mutateBuilder = MutationProto.newBuilder();
184     mutateBuilder.setRow(ZeroCopyLiteralByteString.wrap(row));
185     mutateBuilder.setMutateType(MutationType.INCREMENT);
186     mutateBuilder.setDurability(ProtobufUtil.toDurability(durability));
187     ColumnValue.Builder columnBuilder = ColumnValue.newBuilder();
188     columnBuilder.setFamily(ZeroCopyLiteralByteString.wrap(family));
189     QualifierValue.Builder valueBuilder = QualifierValue.newBuilder();
190     valueBuilder.setValue(ZeroCopyLiteralByteString.wrap(Bytes.toBytes(amount)));
191     valueBuilder.setQualifier(ZeroCopyLiteralByteString.wrap(qualifier));
192     columnBuilder.addQualifierValue(valueBuilder.build());
193     mutateBuilder.addColumnValue(columnBuilder.build());
194     builder.setMutation(mutateBuilder.build());
195     return builder.build();
196   }
197 
198   /**
199    * Create a protocol buffer MutateRequest for a conditioned put
200    *
201    * @param regionName
202    * @param row
203    * @param family
204    * @param qualifier
205    * @param comparator
206    * @param compareType
207    * @param put
208    * @return a mutate request
209    * @throws IOException
210    */
211   public static MutateRequest buildMutateRequest(
212       final byte[] regionName, final byte[] row, final byte[] family,
213       final byte [] qualifier, final ByteArrayComparable comparator,
214       final CompareType compareType, final Put put) throws IOException {
215     MutateRequest.Builder builder = MutateRequest.newBuilder();
216     RegionSpecifier region = buildRegionSpecifier(
217       RegionSpecifierType.REGION_NAME, regionName);
218     builder.setRegion(region);
219     Condition condition = buildCondition(
220       row, family, qualifier, comparator, compareType);
221     builder.setMutation(ProtobufUtil.toMutation(MutationType.PUT, put, MutationProto.newBuilder()));
222     builder.setCondition(condition);
223     return builder.build();
224   }
225 
226   /**
227    * Create a protocol buffer MutateRequest for a conditioned delete
228    *
229    * @param regionName
230    * @param row
231    * @param family
232    * @param qualifier
233    * @param comparator
234    * @param compareType
235    * @param delete
236    * @return a mutate request
237    * @throws IOException
238    */
239   public static MutateRequest buildMutateRequest(
240       final byte[] regionName, final byte[] row, final byte[] family,
241       final byte [] qualifier, final ByteArrayComparable comparator,
242       final CompareType compareType, final Delete delete) throws IOException {
243     MutateRequest.Builder builder = MutateRequest.newBuilder();
244     RegionSpecifier region = buildRegionSpecifier(
245       RegionSpecifierType.REGION_NAME, regionName);
246     builder.setRegion(region);
247     Condition condition = buildCondition(
248       row, family, qualifier, comparator, compareType);
249     builder.setMutation(ProtobufUtil.toMutation(MutationType.DELETE, delete,
250       MutationProto.newBuilder()));
251     builder.setCondition(condition);
252     return builder.build();
253   }
254 
255   /**
256    * Create a protocol buffer MutateRequest for a put
257    *
258    * @param regionName
259    * @param put
260    * @return a mutate request
261    * @throws IOException
262    */
263   public static MutateRequest buildMutateRequest(
264       final byte[] regionName, final Put put) throws IOException {
265     MutateRequest.Builder builder = MutateRequest.newBuilder();
266     RegionSpecifier region = buildRegionSpecifier(
267       RegionSpecifierType.REGION_NAME, regionName);
268     builder.setRegion(region);
269     builder.setMutation(ProtobufUtil.toMutation(MutationType.PUT, put, MutationProto.newBuilder()));
270     return builder.build();
271   }
272 
273   /**
274    * Create a protocol buffer MutateRequest for an append
275    *
276    * @param regionName
277    * @param append
278    * @return a mutate request
279    * @throws IOException
280    */
281   public static MutateRequest buildMutateRequest(
282       final byte[] regionName, final Append append) throws IOException {
283     MutateRequest.Builder builder = MutateRequest.newBuilder();
284     RegionSpecifier region = buildRegionSpecifier(
285       RegionSpecifierType.REGION_NAME, regionName);
286     builder.setRegion(region);
287     builder.setMutation(ProtobufUtil.toMutation(MutationType.APPEND, append,
288       MutationProto.newBuilder()));
289     return builder.build();
290   }
291 
292   /**
293    * Create a protocol buffer MutateRequest for a client increment
294    *
295    * @param regionName
296    * @param increment
297    * @return a mutate request
298    */
299   public static MutateRequest buildMutateRequest(
300       final byte[] regionName, final Increment increment) {
301     MutateRequest.Builder builder = MutateRequest.newBuilder();
302     RegionSpecifier region = buildRegionSpecifier(
303       RegionSpecifierType.REGION_NAME, regionName);
304     builder.setRegion(region);
305     builder.setMutation(ProtobufUtil.toMutation(increment, MutationProto.newBuilder()));
306     return builder.build();
307   }
308 
309   /**
310    * Create a protocol buffer MutateRequest for a delete
311    *
312    * @param regionName
313    * @param delete
314    * @return a mutate request
315    * @throws IOException
316    */
317   public static MutateRequest buildMutateRequest(
318       final byte[] regionName, final Delete delete) throws IOException {
319     MutateRequest.Builder builder = MutateRequest.newBuilder();
320     RegionSpecifier region = buildRegionSpecifier(
321       RegionSpecifierType.REGION_NAME, regionName);
322     builder.setRegion(region);
323     builder.setMutation(ProtobufUtil.toMutation(MutationType.DELETE, delete,
324       MutationProto.newBuilder()));
325     return builder.build();
326   }
327 
328   /**
329    * Create a protocol buffer MultiRequest for row mutations.
330    * Does not propagate Action absolute position.  Does not set atomic action on the created
331    * RegionAtomic.  Caller should do that if wanted.
332    * @param regionName
333    * @param rowMutations
334    * @return a data-laden RegionMutation.Builder
335    * @throws IOException
336    */
337   public static RegionAction.Builder buildRegionAction(final byte [] regionName,
338       final RowMutations rowMutations)
339   throws IOException {
340     RegionAction.Builder builder =
341       getRegionActionBuilderWithRegion(RegionAction.newBuilder(), regionName);
342     ClientProtos.Action.Builder actionBuilder = ClientProtos.Action.newBuilder();
343     MutationProto.Builder mutationBuilder = MutationProto.newBuilder();
344     for (Mutation mutation: rowMutations.getMutations()) {
345       MutationType mutateType = null;
346       if (mutation instanceof Put) {
347         mutateType = MutationType.PUT;
348       } else if (mutation instanceof Delete) {
349         mutateType = MutationType.DELETE;
350       } else {
351         throw new DoNotRetryIOException("RowMutations supports only put and delete, not " +
352           mutation.getClass().getName());
353       }
354       mutationBuilder.clear();
355       MutationProto mp = ProtobufUtil.toMutation(mutateType, mutation, mutationBuilder);
356       actionBuilder.clear();
357       actionBuilder.setMutation(mp);
358       builder.addAction(actionBuilder.build());
359     }
360     return builder;
361   }
362 
363   /**
364    * Create a protocol buffer MultiRequest for row mutations that does not hold data.  Data/Cells
365    * are carried outside of protobuf.  Return references to the Cells in <code>cells</code> param.
366     * Does not propagate Action absolute position.  Does not set atomic action on the created
367    * RegionAtomic.  Caller should do that if wanted.
368    * @param regionName
369    * @param rowMutations
370    * @param cells Return in here a list of Cells as CellIterable.
371    * @return a region mutation minus data
372    * @throws IOException
373    */
374   public static RegionAction.Builder buildNoDataRegionAction(final byte[] regionName,
375       final RowMutations rowMutations, final List<CellScannable> cells,
376       final RegionAction.Builder regionActionBuilder,
377       final ClientProtos.Action.Builder actionBuilder,
378       final MutationProto.Builder mutationBuilder)
379   throws IOException {
380     for (Mutation mutation: rowMutations.getMutations()) {
381       MutationType type = null;
382       if (mutation instanceof Put) {
383         type = MutationType.PUT;
384       } else if (mutation instanceof Delete) {
385         type = MutationType.DELETE;
386       } else {
387         throw new DoNotRetryIOException("RowMutations supports only put and delete, not " +
388           mutation.getClass().getName());
389       }
390       mutationBuilder.clear();
391       MutationProto mp = ProtobufUtil.toMutationNoData(type, mutation, mutationBuilder);
392       cells.add(mutation);
393       actionBuilder.clear();
394       regionActionBuilder.addAction(actionBuilder.setMutation(mp).build());
395     }
396     return regionActionBuilder;
397   }
398 
399   private static RegionAction.Builder getRegionActionBuilderWithRegion(
400       final RegionAction.Builder regionActionBuilder, final byte [] regionName) {
401     RegionSpecifier region = buildRegionSpecifier(RegionSpecifierType.REGION_NAME, regionName);
402     regionActionBuilder.setRegion(region);
403     return regionActionBuilder;
404   }
405 
406   /**
407    * Create a protocol buffer ScanRequest for a client Scan
408    *
409    * @param regionName
410    * @param scan
411    * @param numberOfRows
412    * @param closeScanner
413    * @return a scan request
414    * @throws IOException
415    */
416   public static ScanRequest buildScanRequest(final byte[] regionName,
417       final Scan scan, final int numberOfRows,
418         final boolean closeScanner) throws IOException {
419     ScanRequest.Builder builder = ScanRequest.newBuilder();
420     RegionSpecifier region = buildRegionSpecifier(
421       RegionSpecifierType.REGION_NAME, regionName);
422     builder.setNumberOfRows(numberOfRows);
423     builder.setCloseScanner(closeScanner);
424     builder.setRegion(region);
425     builder.setScan(ProtobufUtil.toScan(scan));
426     return builder.build();
427   }
428 
429   /**
430    * Create a protocol buffer ScanRequest for a scanner id
431    *
432    * @param scannerId
433    * @param numberOfRows
434    * @param closeScanner
435    * @return a scan request
436    */
437   public static ScanRequest buildScanRequest(final long scannerId,
438       final int numberOfRows, final boolean closeScanner) {
439     ScanRequest.Builder builder = ScanRequest.newBuilder();
440     builder.setNumberOfRows(numberOfRows);
441     builder.setCloseScanner(closeScanner);
442     builder.setScannerId(scannerId);
443     return builder.build();
444   }
445 
446   /**
447    * Create a protocol buffer ScanRequest for a scanner id
448    *
449    * @param scannerId
450    * @param numberOfRows
451    * @param closeScanner
452    * @param nextCallSeq
453    * @return a scan request
454    */
455   public static ScanRequest buildScanRequest(final long scannerId, final int numberOfRows,
456       final boolean closeScanner, final long nextCallSeq) {
457     ScanRequest.Builder builder = ScanRequest.newBuilder();
458     builder.setNumberOfRows(numberOfRows);
459     builder.setCloseScanner(closeScanner);
460     builder.setScannerId(scannerId);
461     builder.setNextCallSeq(nextCallSeq);
462     return builder.build();
463   }
464 
465   /**
466    * Create a protocol buffer bulk load request
467    *
468    * @param familyPaths
469    * @param regionName
470    * @param assignSeqNum
471    * @return a bulk load request
472    */
473   public static BulkLoadHFileRequest buildBulkLoadHFileRequest(
474       final List<Pair<byte[], String>> familyPaths,
475       final byte[] regionName, boolean assignSeqNum) {
476     BulkLoadHFileRequest.Builder builder = BulkLoadHFileRequest.newBuilder();
477     RegionSpecifier region = buildRegionSpecifier(
478       RegionSpecifierType.REGION_NAME, regionName);
479     builder.setRegion(region);
480     FamilyPath.Builder familyPathBuilder = FamilyPath.newBuilder();
481     for (Pair<byte[], String> familyPath: familyPaths) {
482       familyPathBuilder.setFamily(ZeroCopyLiteralByteString.wrap(familyPath.getFirst()));
483       familyPathBuilder.setPath(familyPath.getSecond());
484       builder.addFamilyPath(familyPathBuilder.build());
485     }
486     builder.setAssignSeqNum(assignSeqNum);
487     return builder.build();
488   }
489 
490   /**
491    * Create a protocol buffer multi request for a list of actions.
492    * Propagates Actions original index.
493    *
494    * @param regionName
495    * @param actions
496    * @return a multi request
497    * @throws IOException
498    */
499   public static <R> RegionAction.Builder buildRegionAction(final byte[] regionName,
500       final List<Action<R>> actions, final RegionAction.Builder regionActionBuilder,
501       final ClientProtos.Action.Builder actionBuilder,
502       final MutationProto.Builder mutationBuilder)
503   throws IOException {
504     for (Action<R> action: actions) {
505       Row row = action.getAction();
506       actionBuilder.clear();
507       actionBuilder.setIndex(action.getOriginalIndex());
508       mutationBuilder.clear();
509       if (row instanceof Get) {
510         Get g = (Get)row;
511         regionActionBuilder.addAction(actionBuilder.setGet(ProtobufUtil.toGet(g)));
512       } else if (row instanceof Put) {
513         regionActionBuilder.addAction(actionBuilder.
514           setMutation(ProtobufUtil.toMutation(MutationType.PUT, (Put)row, mutationBuilder)));
515       } else if (row instanceof Delete) {
516         regionActionBuilder.addAction(actionBuilder.
517           setMutation(ProtobufUtil.toMutation(MutationType.DELETE, (Delete)row, mutationBuilder)));
518       } else if (row instanceof Append) {
519         regionActionBuilder.addAction(actionBuilder.
520           setMutation(ProtobufUtil.toMutation(MutationType.APPEND, (Append)row, mutationBuilder)));
521       } else if (row instanceof Increment) {
522         regionActionBuilder.addAction(actionBuilder.
523           setMutation(ProtobufUtil.toMutation((Increment)row, mutationBuilder)));
524       } else if (row instanceof RowMutations) {
525         throw new UnsupportedOperationException("No RowMutations in multi calls; use mutateRow");
526       } else {
527         throw new DoNotRetryIOException("Multi doesn't support " + row.getClass().getName());
528       }
529     }
530     return regionActionBuilder;
531   }
532 
533   /**
534    * Create a protocol buffer multirequest with NO data for a list of actions (data is carried
535    * otherwise than via protobuf).  This means it just notes attributes, whether to write the
536    * WAL, etc., and the presence in protobuf serves as place holder for the data which is
537    * coming along otherwise.  Note that Get is different.  It does not contain 'data' and is always
538    * carried by protobuf.  We return references to the data by adding them to the passed in
539    * <code>data</code> param.
540    *
541    * <p>Propagates Actions original index.
542    *
543    * @param regionName
544    * @param actions
545    * @param cells Place to stuff references to actual data.
546    * @return a multi request that does not carry any data.
547    * @throws IOException
548    */
549   public static <R> RegionAction.Builder buildNoDataRegionAction(final byte[] regionName,
550       final List<Action<R>> actions, final List<CellScannable> cells,
551       final RegionAction.Builder regionActionBuilder,
552       final ClientProtos.Action.Builder actionBuilder,
553       final MutationProto.Builder mutationBuilder)
554   throws IOException {
555     RegionAction.Builder builder =
556       getRegionActionBuilderWithRegion(RegionAction.newBuilder(), regionName);
557     for (Action<R> action: actions) {
558       Row row = action.getAction();
559       actionBuilder.clear();
560       actionBuilder.setIndex(action.getOriginalIndex());
561       mutationBuilder.clear();
562       if (row instanceof Get) {
563         Get g = (Get)row;
564         builder.addAction(actionBuilder.setGet(ProtobufUtil.toGet(g)));
565       } else if (row instanceof Put) {
566         Put p = (Put)row;
567         cells.add(p);
568         builder.addAction(actionBuilder.
569           setMutation(ProtobufUtil.toMutationNoData(MutationType.PUT, p, mutationBuilder)));
570       } else if (row instanceof Delete) {
571         Delete d = (Delete)row;
572         int size = d.size();
573         // Note that a legitimate Delete may have a size of zero; i.e. a Delete that has nothing
574         // in it but the row to delete.  In this case, the current implementation does not make
575         // a KeyValue to represent a delete-of-all-the-row until we serialize... For such cases
576         // where the size returned is zero, we will send the Delete fully pb'd rather than have
577         // metadata only in the pb and then send the kv along the side in cells.
578         if (size > 0) {
579           cells.add(d);
580           builder.addAction(actionBuilder.
581             setMutation(ProtobufUtil.toMutationNoData(MutationType.DELETE, d, mutationBuilder)));
582         } else {
583           builder.addAction(actionBuilder.
584             setMutation(ProtobufUtil.toMutation(MutationType.DELETE, d, mutationBuilder)));
585         }
586       } else if (row instanceof Append) {
587         Append a = (Append)row;
588         cells.add(a);
589         builder.addAction(actionBuilder.
590           setMutation(ProtobufUtil.toMutationNoData(MutationType.APPEND, a, mutationBuilder)));
591       } else if (row instanceof Increment) {
592         Increment i = (Increment)row;
593         cells.add(i);
594         builder.addAction(actionBuilder.
595           setMutation(ProtobufUtil.toMutationNoData(MutationType.INCREMENT, i, mutationBuilder)));
596       } else if (row instanceof RowMutations) {
597         continue; // ignore RowMutations
598       } else {
599         throw new DoNotRetryIOException("Multi doesn't support " + row.getClass().getName());
600       }
601     }
602     return builder;
603   }
604 
605 // End utilities for Client
606 //Start utilities for Admin
607 
608   /**
609    * Create a protocol buffer GetRegionInfoRequest for a given region name
610    *
611    * @param regionName the name of the region to get info
612    * @return a protocol buffer GetRegionInfoRequest
613    */
614   public static GetRegionInfoRequest
615       buildGetRegionInfoRequest(final byte[] regionName) {
616     return buildGetRegionInfoRequest(regionName, false);
617   }
618 
619   /**
620    * Create a protocol buffer GetRegionInfoRequest for a given region name
621    *
622    * @param regionName the name of the region to get info
623    * @param includeCompactionState indicate if the compaction state is requested
624    * @return a protocol buffer GetRegionInfoRequest
625    */
626   public static GetRegionInfoRequest
627       buildGetRegionInfoRequest(final byte[] regionName,
628         final boolean includeCompactionState) {
629     GetRegionInfoRequest.Builder builder = GetRegionInfoRequest.newBuilder();
630     RegionSpecifier region = buildRegionSpecifier(
631       RegionSpecifierType.REGION_NAME, regionName);
632     builder.setRegion(region);
633     if (includeCompactionState) {
634       builder.setCompactionState(includeCompactionState);
635     }
636     return builder.build();
637   }
638 
639  /**
640   * Create a protocol buffer GetStoreFileRequest for a given region name
641   *
642   * @param regionName the name of the region to get info
643   * @param family the family to get store file list
644   * @return a protocol buffer GetStoreFileRequest
645   */
646  public static GetStoreFileRequest
647      buildGetStoreFileRequest(final byte[] regionName, final byte[] family) {
648    GetStoreFileRequest.Builder builder = GetStoreFileRequest.newBuilder();
649    RegionSpecifier region = buildRegionSpecifier(
650      RegionSpecifierType.REGION_NAME, regionName);
651    builder.setRegion(region);
652    builder.addFamily(ZeroCopyLiteralByteString.wrap(family));
653    return builder.build();
654  }
655 
656  /**
657   * Create a protocol buffer GetOnlineRegionRequest
658   *
659   * @return a protocol buffer GetOnlineRegionRequest
660   */
661  public static GetOnlineRegionRequest buildGetOnlineRegionRequest() {
662    return GetOnlineRegionRequest.newBuilder().build();
663  }
664 
665  /**
666   * Create a protocol buffer FlushRegionRequest for a given region name
667   *
668   * @param regionName the name of the region to get info
669   * @return a protocol buffer FlushRegionRequest
670   */
671  public static FlushRegionRequest
672      buildFlushRegionRequest(final byte[] regionName) {
673    FlushRegionRequest.Builder builder = FlushRegionRequest.newBuilder();
674    RegionSpecifier region = buildRegionSpecifier(
675      RegionSpecifierType.REGION_NAME, regionName);
676    builder.setRegion(region);
677    return builder.build();
678  }
679 
680  /**
681   * Create a protocol buffer OpenRegionRequest to open a list of regions
682   *
683   * @param regionOpenInfos info of a list of regions to open
684   * @return a protocol buffer OpenRegionRequest
685   */
686  public static OpenRegionRequest
687      buildOpenRegionRequest(final List<Triple<HRegionInfo, Integer,
688          List<ServerName>>> regionOpenInfos) {
689    OpenRegionRequest.Builder builder = OpenRegionRequest.newBuilder();
690    for (Triple<HRegionInfo, Integer, List<ServerName>> regionOpenInfo: regionOpenInfos) {
691      Integer second = regionOpenInfo.getSecond();
692      int versionOfOfflineNode = second == null ? -1 : second.intValue();
693      builder.addOpenInfo(buildRegionOpenInfo(
694        regionOpenInfo.getFirst(), versionOfOfflineNode, regionOpenInfo.getThird()));
695    }
696    return builder.build();
697  }
698 
699  /**
700   * Create a protocol buffer OpenRegionRequest for a given region
701   *
702   * @param region the region to open
703  * @param versionOfOfflineNode that needs to be present in the offline node
704  * @param favoredNodes
705   * @return a protocol buffer OpenRegionRequest
706   */
707  public static OpenRegionRequest buildOpenRegionRequest(
708      final HRegionInfo region, final int versionOfOfflineNode, List<ServerName> favoredNodes) {
709    OpenRegionRequest.Builder builder = OpenRegionRequest.newBuilder();
710    builder.addOpenInfo(buildRegionOpenInfo(region, versionOfOfflineNode, favoredNodes));
711    return builder.build();
712  }
713 
714  /**
715   * Create a protocol buffer UpdateFavoredNodesRequest to update a list of favorednode mappings
716   * @param updateRegionInfos
717   * @return a protocol buffer UpdateFavoredNodesRequest
718   */
719  public static UpdateFavoredNodesRequest buildUpdateFavoredNodesRequest(
720      final List<Pair<HRegionInfo, List<ServerName>>> updateRegionInfos) {
721    UpdateFavoredNodesRequest.Builder ubuilder = UpdateFavoredNodesRequest.newBuilder();
722    for (Pair<HRegionInfo, List<ServerName>> pair : updateRegionInfos) {
723      RegionUpdateInfo.Builder builder = RegionUpdateInfo.newBuilder();
724      builder.setRegion(HRegionInfo.convert(pair.getFirst()));
725      for (ServerName server : pair.getSecond()) {
726        builder.addFavoredNodes(ProtobufUtil.toServerName(server));
727      }
728      ubuilder.addUpdateInfo(builder.build());
729    }
730    return ubuilder.build();
731  }
732 
733  /**
734   * Create a CloseRegionRequest for a given region name
735   *
736   * @param regionName the name of the region to close
737   * @param transitionInZK indicator if to transition in ZK
738   * @return a CloseRegionRequest
739   */
740  public static CloseRegionRequest buildCloseRegionRequest(
741      final byte[] regionName, final boolean transitionInZK) {
742    CloseRegionRequest.Builder builder = CloseRegionRequest.newBuilder();
743    RegionSpecifier region = buildRegionSpecifier(
744      RegionSpecifierType.REGION_NAME, regionName);
745    builder.setRegion(region);
746    builder.setTransitionInZK(transitionInZK);
747    return builder.build();
748  }
749 
750   public static CloseRegionRequest buildCloseRegionRequest(
751     final byte[] regionName, final int versionOfClosingNode,
752     ServerName destinationServer, final boolean transitionInZK) {
753     CloseRegionRequest.Builder builder = CloseRegionRequest.newBuilder();
754     RegionSpecifier region = buildRegionSpecifier(
755       RegionSpecifierType.REGION_NAME, regionName);
756     builder.setRegion(region);
757     builder.setVersionOfClosingNode(versionOfClosingNode);
758     builder.setTransitionInZK(transitionInZK);
759     if (destinationServer != null){
760       builder.setDestinationServer(ProtobufUtil.toServerName( destinationServer) );
761     }
762     return builder.build();
763   }
764 
765  /**
766   * Create a CloseRegionRequest for a given encoded region name
767   *
768   * @param encodedRegionName the name of the region to close
769   * @param transitionInZK indicator if to transition in ZK
770   * @return a CloseRegionRequest
771   */
772  public static CloseRegionRequest
773      buildCloseRegionRequest(final String encodedRegionName,
774        final boolean transitionInZK) {
775    CloseRegionRequest.Builder builder = CloseRegionRequest.newBuilder();
776    RegionSpecifier region = buildRegionSpecifier(
777      RegionSpecifierType.ENCODED_REGION_NAME,
778      Bytes.toBytes(encodedRegionName));
779    builder.setRegion(region);
780    builder.setTransitionInZK(transitionInZK);
781    return builder.build();
782  }
783 
784  /**
785   * Create a SplitRegionRequest for a given region name
786   *
787   * @param regionName the name of the region to split
788   * @param splitPoint the split point
789   * @return a SplitRegionRequest
790   */
791  public static SplitRegionRequest buildSplitRegionRequest(
792      final byte[] regionName, final byte[] splitPoint) {
793    SplitRegionRequest.Builder builder = SplitRegionRequest.newBuilder();
794    RegionSpecifier region = buildRegionSpecifier(
795      RegionSpecifierType.REGION_NAME, regionName);
796    builder.setRegion(region);
797    if (splitPoint != null) {
798      builder.setSplitPoint(ZeroCopyLiteralByteString.wrap(splitPoint));
799    }
800    return builder.build();
801  }
802 
803   /**
804    * Create a MergeRegionsRequest for the given regions
805    * @param regionA name of region a
806    * @param regionB name of region b
807    * @param forcible true if it is a compulsory merge
808    * @return a MergeRegionsRequest
809    */
810   public static MergeRegionsRequest buildMergeRegionsRequest(
811       final byte[] regionA, final byte[] regionB, final boolean forcible) {
812     MergeRegionsRequest.Builder builder = MergeRegionsRequest.newBuilder();
813     RegionSpecifier regionASpecifier = buildRegionSpecifier(
814         RegionSpecifierType.REGION_NAME, regionA);
815     RegionSpecifier regionBSpecifier = buildRegionSpecifier(
816         RegionSpecifierType.REGION_NAME, regionB);
817     builder.setRegionA(regionASpecifier);
818     builder.setRegionB(regionBSpecifier);
819     builder.setForcible(forcible);
820     return builder.build();
821   }
822 
823  /**
824   * Create a  CompactRegionRequest for a given region name
825   *
826   * @param regionName the name of the region to get info
827   * @param major indicator if it is a major compaction
828   * @return a CompactRegionRequest
829   */
830  public static CompactRegionRequest buildCompactRegionRequest(
831      final byte[] regionName, final boolean major, final byte [] family) {
832    CompactRegionRequest.Builder builder = CompactRegionRequest.newBuilder();
833    RegionSpecifier region = buildRegionSpecifier(
834      RegionSpecifierType.REGION_NAME, regionName);
835    builder.setRegion(region);
836    builder.setMajor(major);
837    if (family != null) {
838      builder.setFamily(ZeroCopyLiteralByteString.wrap(family));
839    }
840    return builder.build();
841  }
842 
843  /**
844   * @see {@link #buildRollWALWriterRequest()
845   */
846  private static RollWALWriterRequest ROLL_WAL_WRITER_REQUEST =
847      RollWALWriterRequest.newBuilder().build();
848 
849   /**
850   * Create a new RollWALWriterRequest
851   *
852   * @return a ReplicateWALEntryRequest
853   */
854  public static RollWALWriterRequest buildRollWALWriterRequest() {
855    return ROLL_WAL_WRITER_REQUEST;
856  }
857 
858  /**
859   * @see {@link #buildGetServerInfoRequest()}
860   */
861  private static GetServerInfoRequest GET_SERVER_INFO_REQUEST =
862    GetServerInfoRequest.newBuilder().build();
863 
864  /**
865   * Create a new GetServerInfoRequest
866   *
867   * @return a GetServerInfoRequest
868   */
869  public static GetServerInfoRequest buildGetServerInfoRequest() {
870    return GET_SERVER_INFO_REQUEST;
871  }
872 
873  /**
874   * Create a new StopServerRequest
875   *
876   * @param reason the reason to stop the server
877   * @return a StopServerRequest
878   */
879  public static StopServerRequest buildStopServerRequest(final String reason) {
880    StopServerRequest.Builder builder = StopServerRequest.newBuilder();
881    builder.setReason(reason);
882    return builder.build();
883  }
884 
885 //End utilities for Admin
886 
887   /**
888    * Convert a byte array to a protocol buffer RegionSpecifier
889    *
890    * @param type the region specifier type
891    * @param value the region specifier byte array value
892    * @return a protocol buffer RegionSpecifier
893    */
894   public static RegionSpecifier buildRegionSpecifier(
895       final RegionSpecifierType type, final byte[] value) {
896     RegionSpecifier.Builder regionBuilder = RegionSpecifier.newBuilder();
897     regionBuilder.setValue(ZeroCopyLiteralByteString.wrap(value));
898     regionBuilder.setType(type);
899     return regionBuilder.build();
900   }
901 
902   /**
903    * Create a protocol buffer Condition
904    *
905    * @param row
906    * @param family
907    * @param qualifier
908    * @param comparator
909    * @param compareType
910    * @return a Condition
911    * @throws IOException
912    */
913   private static Condition buildCondition(final byte[] row,
914       final byte[] family, final byte [] qualifier,
915       final ByteArrayComparable comparator,
916       final CompareType compareType) throws IOException {
917     Condition.Builder builder = Condition.newBuilder();
918     builder.setRow(ZeroCopyLiteralByteString.wrap(row));
919     builder.setFamily(ZeroCopyLiteralByteString.wrap(family));
920     builder.setQualifier(ZeroCopyLiteralByteString.wrap(qualifier));
921     builder.setComparator(ProtobufUtil.toComparator(comparator));
922     builder.setCompareType(compareType);
923     return builder.build();
924   }
925 
926   /**
927    * Create a protocol buffer AddColumnRequest
928    *
929    * @param tableName
930    * @param column
931    * @return an AddColumnRequest
932    */
933   public static AddColumnRequest buildAddColumnRequest(
934       final TableName tableName, final HColumnDescriptor column) {
935     AddColumnRequest.Builder builder = AddColumnRequest.newBuilder();
936     builder.setTableName(ProtobufUtil.toProtoTableName(tableName));
937     builder.setColumnFamilies(column.convert());
938     return builder.build();
939   }
940 
941   /**
942    * Create a protocol buffer DeleteColumnRequest
943    *
944    * @param tableName
945    * @param columnName
946    * @return a DeleteColumnRequest
947    */
948   public static DeleteColumnRequest buildDeleteColumnRequest(
949       final TableName tableName, final byte [] columnName) {
950     DeleteColumnRequest.Builder builder = DeleteColumnRequest.newBuilder();
951     builder.setTableName(ProtobufUtil.toProtoTableName((tableName)));
952     builder.setColumnName(ZeroCopyLiteralByteString.wrap(columnName));
953     return builder.build();
954   }
955 
956   /**
957    * Create a protocol buffer ModifyColumnRequest
958    *
959    * @param tableName
960    * @param column
961    * @return an ModifyColumnRequest
962    */
963   public static ModifyColumnRequest buildModifyColumnRequest(
964       final TableName tableName, final HColumnDescriptor column) {
965     ModifyColumnRequest.Builder builder = ModifyColumnRequest.newBuilder();
966     builder.setTableName(ProtobufUtil.toProtoTableName((tableName)));
967     builder.setColumnFamilies(column.convert());
968     return builder.build();
969   }
970 
971   /**
972    * Create a protocol buffer MoveRegionRequest
973    *
974    * @param encodedRegionName
975    * @param destServerName
976    * @return A MoveRegionRequest
977    * @throws DeserializationException
978    */
979   public static MoveRegionRequest buildMoveRegionRequest(
980       final byte [] encodedRegionName, final byte [] destServerName) throws
981       DeserializationException {
982 	MoveRegionRequest.Builder builder = MoveRegionRequest.newBuilder();
983     builder.setRegion(
984       buildRegionSpecifier(RegionSpecifierType.ENCODED_REGION_NAME,encodedRegionName));
985     if (destServerName != null) {
986       builder.setDestServerName(
987         ProtobufUtil.toServerName(ServerName.valueOf(Bytes.toString(destServerName))));
988     }
989     return builder.build();
990   }
991 
992   public static DispatchMergingRegionsRequest buildDispatchMergingRegionsRequest(
993       final byte[] encodedNameOfRegionA, final byte[] encodedNameOfRegionB,
994       final boolean forcible) throws DeserializationException {
995     DispatchMergingRegionsRequest.Builder builder = DispatchMergingRegionsRequest.newBuilder();
996     builder.setRegionA(buildRegionSpecifier(
997         RegionSpecifierType.ENCODED_REGION_NAME, encodedNameOfRegionA));
998     builder.setRegionB(buildRegionSpecifier(
999         RegionSpecifierType.ENCODED_REGION_NAME, encodedNameOfRegionB));
1000     builder.setForcible(forcible);
1001     return builder.build();
1002   }
1003 
1004   /**
1005    * Create a protocol buffer AssignRegionRequest
1006    *
1007    * @param regionName
1008    * @return an AssignRegionRequest
1009    */
1010   public static AssignRegionRequest buildAssignRegionRequest(final byte [] regionName) {
1011     AssignRegionRequest.Builder builder = AssignRegionRequest.newBuilder();
1012     builder.setRegion(buildRegionSpecifier(RegionSpecifierType.REGION_NAME,regionName));
1013     return builder.build();
1014   }
1015 
1016   /**
1017    * Creates a protocol buffer UnassignRegionRequest
1018    *
1019    * @param regionName
1020    * @param force
1021    * @return an UnassignRegionRequest
1022    */
1023   public static UnassignRegionRequest buildUnassignRegionRequest(
1024       final byte [] regionName, final boolean force) {
1025     UnassignRegionRequest.Builder builder = UnassignRegionRequest.newBuilder();
1026     builder.setRegion(buildRegionSpecifier(RegionSpecifierType.REGION_NAME,regionName));
1027     builder.setForce(force);
1028     return builder.build();
1029   }
1030 
1031   /**
1032    * Creates a protocol buffer OfflineRegionRequest
1033    *
1034    * @param regionName
1035    * @return an OfflineRegionRequest
1036    */
1037   public static OfflineRegionRequest buildOfflineRegionRequest(final byte [] regionName) {
1038     OfflineRegionRequest.Builder builder = OfflineRegionRequest.newBuilder();
1039     builder.setRegion(buildRegionSpecifier(RegionSpecifierType.REGION_NAME,regionName));
1040     return builder.build();
1041   }
1042 
1043   /**
1044    * Creates a protocol buffer DeleteTableRequest
1045    *
1046    * @param tableName
1047    * @return a DeleteTableRequest
1048    */
1049   public static DeleteTableRequest buildDeleteTableRequest(final TableName tableName) {
1050     DeleteTableRequest.Builder builder = DeleteTableRequest.newBuilder();
1051     builder.setTableName(ProtobufUtil.toProtoTableName(tableName));
1052     return builder.build();
1053   }
1054 
1055   /**
1056    * Creates a protocol buffer EnableTableRequest
1057    *
1058    * @param tableName
1059    * @return an EnableTableRequest
1060    */
1061   public static EnableTableRequest buildEnableTableRequest(final TableName tableName) {
1062     EnableTableRequest.Builder builder = EnableTableRequest.newBuilder();
1063     builder.setTableName(ProtobufUtil.toProtoTableName(tableName));
1064     return builder.build();
1065   }
1066 
1067   /**
1068    * Creates a protocol buffer DisableTableRequest
1069    *
1070    * @param tableName
1071    * @return a DisableTableRequest
1072    */
1073   public static DisableTableRequest buildDisableTableRequest(final TableName tableName) {
1074     DisableTableRequest.Builder builder = DisableTableRequest.newBuilder();
1075     builder.setTableName(ProtobufUtil.toProtoTableName((tableName)));
1076     return builder.build();
1077   }
1078 
1079   /**
1080    * Creates a protocol buffer CreateTableRequest
1081    *
1082    * @param hTableDesc
1083    * @param splitKeys
1084    * @return a CreateTableRequest
1085    */
1086   public static CreateTableRequest buildCreateTableRequest(
1087       final HTableDescriptor hTableDesc, final byte [][] splitKeys) {
1088     CreateTableRequest.Builder builder = CreateTableRequest.newBuilder();
1089     builder.setTableSchema(hTableDesc.convert());
1090     if (splitKeys != null) {
1091       for (byte [] splitKey : splitKeys) {
1092         builder.addSplitKeys(ZeroCopyLiteralByteString.wrap(splitKey));
1093       }
1094     }
1095     return builder.build();
1096   }
1097 
1098 
1099   /**
1100    * Creates a protocol buffer ModifyTableRequest
1101    *
1102    * @param tableName
1103    * @param hTableDesc
1104    * @return a ModifyTableRequest
1105    */
1106   public static ModifyTableRequest buildModifyTableRequest(
1107       final TableName tableName, final HTableDescriptor hTableDesc) {
1108     ModifyTableRequest.Builder builder = ModifyTableRequest.newBuilder();
1109     builder.setTableName(ProtobufUtil.toProtoTableName((tableName)));
1110     builder.setTableSchema(hTableDesc.convert());
1111     return builder.build();
1112   }
1113 
1114   /**
1115    * Creates a protocol buffer GetSchemaAlterStatusRequest
1116    *
1117    * @param tableName
1118    * @return a GetSchemaAlterStatusRequest
1119    */
1120   public static GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(
1121       final TableName tableName) {
1122     GetSchemaAlterStatusRequest.Builder builder = GetSchemaAlterStatusRequest.newBuilder();
1123     builder.setTableName(ProtobufUtil.toProtoTableName((tableName)));
1124     return builder.build();
1125   }
1126 
1127   /**
1128    * Creates a protocol buffer GetTableDescriptorsRequest
1129    *
1130    * @param tableNames
1131    * @return a GetTableDescriptorsRequest
1132    */
1133   public static GetTableDescriptorsRequest buildGetTableDescriptorsRequest(
1134       final List<TableName> tableNames) {
1135     GetTableDescriptorsRequest.Builder builder = GetTableDescriptorsRequest.newBuilder();
1136     if (tableNames != null) {
1137       for (TableName tableName : tableNames) {
1138         builder.addTableNames(ProtobufUtil.toProtoTableName(tableName));
1139       }
1140     }
1141     return builder.build();
1142   }
1143 
1144   /**
1145    * Creates a protocol buffer GetTableDescriptorsRequest for a single table
1146    *
1147    * @param tableName the table name
1148    * @return a GetTableDescriptorsRequest
1149    */
1150   public static GetTableDescriptorsRequest buildGetTableDescriptorsRequest(
1151       final TableName tableName) {
1152     return GetTableDescriptorsRequest.newBuilder()
1153       .addTableNames(ProtobufUtil.toProtoTableName(tableName))
1154       .build();
1155   }
1156 
1157   /**
1158    * Creates a protocol buffer IsMasterRunningRequest
1159    *
1160    * @return a IsMasterRunningRequest
1161    */
1162   public static IsMasterRunningRequest buildIsMasterRunningRequest() {
1163     return IsMasterRunningRequest.newBuilder().build();
1164   }
1165 
1166   /**
1167    * Creates a protocol buffer BalanceRequest
1168    *
1169    * @return a BalanceRequest
1170    */
1171   public static BalanceRequest buildBalanceRequest() {
1172     return BalanceRequest.newBuilder().build();
1173   }
1174 
1175   /**
1176    * Creates a protocol buffer SetBalancerRunningRequest
1177    *
1178    * @param on
1179    * @param synchronous
1180    * @return a SetBalancerRunningRequest
1181    */
1182   public static SetBalancerRunningRequest buildSetBalancerRunningRequest(boolean on, boolean synchronous) {
1183     return SetBalancerRunningRequest.newBuilder().setOn(on).setSynchronous(synchronous).build();
1184   }
1185 
1186   /**
1187    * @see {@link #buildGetClusterStatusRequest}
1188    */
1189   private static final GetClusterStatusRequest GET_CLUSTER_STATUS_REQUEST =
1190       GetClusterStatusRequest.newBuilder().build();
1191 
1192   /**
1193    * Creates a protocol buffer GetClusterStatusRequest
1194    *
1195    * @return A GetClusterStatusRequest
1196    */
1197   public static GetClusterStatusRequest buildGetClusterStatusRequest() {
1198     return GET_CLUSTER_STATUS_REQUEST;
1199   }
1200 
1201   /**
1202    * @see {@link #buildCatalogScanRequest}
1203    */
1204   private static final RunCatalogScanRequest CATALOG_SCAN_REQUEST =
1205     RunCatalogScanRequest.newBuilder().build();
1206 
1207   /**
1208    * Creates a request for running a catalog scan
1209    * @return A {@link RunCatalogScanRequest}
1210    */
1211   public static RunCatalogScanRequest buildCatalogScanRequest() {
1212     return CATALOG_SCAN_REQUEST;
1213   }
1214 
1215   /**
1216    * Creates a request for enabling/disabling the catalog janitor
1217    * @return A {@link EnableCatalogJanitorRequest}
1218    */
1219   public static EnableCatalogJanitorRequest buildEnableCatalogJanitorRequest(boolean enable) {
1220     return EnableCatalogJanitorRequest.newBuilder().setEnable(enable).build();
1221   }
1222 
1223   /**
1224    * @see {@link #buildIsCatalogJanitorEnabledRequest()}
1225    */
1226   private static final IsCatalogJanitorEnabledRequest IS_CATALOG_JANITOR_ENABLED_REQUEST =
1227     IsCatalogJanitorEnabledRequest.newBuilder().build();
1228 
1229   /**
1230    * Creates a request for querying the master whether the catalog janitor is enabled
1231    * @return A {@link IsCatalogJanitorEnabledRequest}
1232    */
1233   public static IsCatalogJanitorEnabledRequest buildIsCatalogJanitorEnabledRequest() {
1234     return IS_CATALOG_JANITOR_ENABLED_REQUEST;
1235   }
1236 
1237   /**
1238    * Creates a request for querying the master the last flushed sequence Id for a region
1239    * @param regionName
1240    * @return A {@link GetLastFlushedSequenceIdRequest}
1241    */
1242   public static GetLastFlushedSequenceIdRequest buildGetLastFlushedSequenceIdRequest(
1243       byte[] regionName) {
1244     return GetLastFlushedSequenceIdRequest.newBuilder().setRegionName(
1245         ZeroCopyLiteralByteString.wrap(regionName)).build();
1246   }
1247 
1248   /**
1249    * Create a request to grant user permissions.
1250    *
1251    * @param username the short user name who to grant permissions
1252    * @param actions the permissions to be granted
1253    * @return A {@link AccessControlProtos} GrantRequest
1254    */
1255   public static AccessControlProtos.GrantRequest buildGrantRequest(
1256       String username, AccessControlProtos.Permission.Action... actions) {
1257     AccessControlProtos.Permission.Builder ret =
1258         AccessControlProtos.Permission.newBuilder();
1259     AccessControlProtos.GlobalPermission.Builder permissionBuilder =
1260         AccessControlProtos.GlobalPermission.newBuilder();
1261     for (AccessControlProtos.Permission.Action a : actions) {
1262       permissionBuilder.addAction(a);
1263     }
1264     ret.setType(AccessControlProtos.Permission.Type.Global)
1265        .setGlobalPermission(permissionBuilder);
1266     return AccessControlProtos.GrantRequest.newBuilder()
1267       .setUserPermission(
1268           AccessControlProtos.UserPermission.newBuilder()
1269               .setUser(ByteString.copyFromUtf8(username))
1270               .setPermission(ret)
1271       ).build();
1272   }
1273 
1274   /**
1275    * Create a request to grant user permissions.
1276    *
1277    * @param username the short user name who to grant permissions
1278    * @param tableName optional table name the permissions apply
1279    * @param family optional column family
1280    * @param qualifier optional qualifier
1281    * @param actions the permissions to be granted
1282    * @return A {@link AccessControlProtos} GrantRequest
1283    */
1284   public static AccessControlProtos.GrantRequest buildGrantRequest(
1285       String username, TableName tableName, byte[] family, byte[] qualifier,
1286       AccessControlProtos.Permission.Action... actions) {
1287     AccessControlProtos.Permission.Builder ret =
1288         AccessControlProtos.Permission.newBuilder();
1289     AccessControlProtos.TablePermission.Builder permissionBuilder =
1290         AccessControlProtos.TablePermission.newBuilder();
1291     for (AccessControlProtos.Permission.Action a : actions) {
1292       permissionBuilder.addAction(a);
1293     }
1294     if (tableName == null) {
1295       throw new NullPointerException("TableName cannot be null");
1296     }
1297     permissionBuilder.setTableName(ProtobufUtil.toProtoTableName(tableName));
1298 
1299     if (family != null) {
1300       permissionBuilder.setFamily(ZeroCopyLiteralByteString.wrap(family));
1301     }
1302     if (qualifier != null) {
1303       permissionBuilder.setQualifier(ZeroCopyLiteralByteString.wrap(qualifier));
1304     }
1305     ret.setType(AccessControlProtos.Permission.Type.Table)
1306        .setTablePermission(permissionBuilder);
1307     return AccessControlProtos.GrantRequest.newBuilder()
1308       .setUserPermission(
1309           AccessControlProtos.UserPermission.newBuilder()
1310               .setUser(ByteString.copyFromUtf8(username))
1311               .setPermission(ret)
1312       ).build();
1313   }
1314 
1315   /**
1316    * Create a request to grant user permissions.
1317    *
1318    * @param username the short user name who to grant permissions
1319    * @param namespace optional table name the permissions apply
1320    * @param actions the permissions to be granted
1321    * @return A {@link AccessControlProtos} GrantRequest
1322    */
1323   public static AccessControlProtos.GrantRequest buildGrantRequest(
1324       String username, String namespace,
1325       AccessControlProtos.Permission.Action... actions) {
1326     AccessControlProtos.Permission.Builder ret =
1327         AccessControlProtos.Permission.newBuilder();
1328     AccessControlProtos.NamespacePermission.Builder permissionBuilder =
1329         AccessControlProtos.NamespacePermission.newBuilder();
1330     for (AccessControlProtos.Permission.Action a : actions) {
1331       permissionBuilder.addAction(a);
1332     }
1333     if (namespace != null) {
1334       permissionBuilder.setNamespaceName(ByteString.copyFromUtf8(namespace));
1335     }
1336     ret.setType(AccessControlProtos.Permission.Type.Namespace)
1337        .setNamespacePermission(permissionBuilder);
1338     return AccessControlProtos.GrantRequest.newBuilder()
1339       .setUserPermission(
1340           AccessControlProtos.UserPermission.newBuilder()
1341               .setUser(ByteString.copyFromUtf8(username))
1342               .setPermission(ret)
1343       ).build();
1344   }
1345 
1346   /**
1347    * Create a request to revoke user permissions.
1348    *
1349    * @param username the short user name whose permissions to be revoked
1350    * @param actions the permissions to be revoked
1351    * @return A {@link AccessControlProtos} RevokeRequest
1352    */
1353   public static AccessControlProtos.RevokeRequest buildRevokeRequest(
1354       String username, AccessControlProtos.Permission.Action... actions) {
1355     AccessControlProtos.Permission.Builder ret =
1356         AccessControlProtos.Permission.newBuilder();
1357     AccessControlProtos.GlobalPermission.Builder permissionBuilder =
1358         AccessControlProtos.GlobalPermission.newBuilder();
1359     for (AccessControlProtos.Permission.Action a : actions) {
1360       permissionBuilder.addAction(a);
1361     }
1362     ret.setType(AccessControlProtos.Permission.Type.Global)
1363        .setGlobalPermission(permissionBuilder);
1364     return AccessControlProtos.RevokeRequest.newBuilder()
1365       .setUserPermission(
1366           AccessControlProtos.UserPermission.newBuilder()
1367               .setUser(ByteString.copyFromUtf8(username))
1368               .setPermission(ret)
1369       ).build();
1370   }
1371 
1372   /**
1373    * Create a request to revoke user permissions.
1374    *
1375    * @param username the short user name whose permissions to be revoked
1376    * @param tableName optional table name the permissions apply
1377    * @param family optional column family
1378    * @param qualifier optional qualifier
1379    * @param actions the permissions to be revoked
1380    * @return A {@link AccessControlProtos} RevokeRequest
1381    */
1382   public static AccessControlProtos.RevokeRequest buildRevokeRequest(
1383       String username, TableName tableName, byte[] family, byte[] qualifier,
1384       AccessControlProtos.Permission.Action... actions) {
1385     AccessControlProtos.Permission.Builder ret =
1386         AccessControlProtos.Permission.newBuilder();
1387     AccessControlProtos.TablePermission.Builder permissionBuilder =
1388         AccessControlProtos.TablePermission.newBuilder();
1389     for (AccessControlProtos.Permission.Action a : actions) {
1390       permissionBuilder.addAction(a);
1391     }
1392     if (tableName != null) {
1393       permissionBuilder.setTableName(ProtobufUtil.toProtoTableName(tableName));
1394     }
1395     if (family != null) {
1396       permissionBuilder.setFamily(ZeroCopyLiteralByteString.wrap(family));
1397     }
1398     if (qualifier != null) {
1399       permissionBuilder.setQualifier(ZeroCopyLiteralByteString.wrap(qualifier));
1400     }
1401     ret.setType(AccessControlProtos.Permission.Type.Table)
1402        .setTablePermission(permissionBuilder);
1403     return AccessControlProtos.RevokeRequest.newBuilder()
1404       .setUserPermission(
1405           AccessControlProtos.UserPermission.newBuilder()
1406               .setUser(ByteString.copyFromUtf8(username))
1407               .setPermission(ret)
1408       ).build();
1409   }
1410 
1411   /**
1412    * Create a request to revoke user permissions.
1413    *
1414    * @param username the short user name whose permissions to be revoked
1415    * @param namespace optional table name the permissions apply
1416    * @param actions the permissions to be revoked
1417    * @return A {@link AccessControlProtos} RevokeRequest
1418    */
1419   public static AccessControlProtos.RevokeRequest buildRevokeRequest(
1420       String username, String namespace,
1421       AccessControlProtos.Permission.Action... actions) {
1422     AccessControlProtos.Permission.Builder ret =
1423         AccessControlProtos.Permission.newBuilder();
1424     AccessControlProtos.NamespacePermission.Builder permissionBuilder =
1425         AccessControlProtos.NamespacePermission.newBuilder();
1426     for (AccessControlProtos.Permission.Action a : actions) {
1427       permissionBuilder.addAction(a);
1428     }
1429     if (namespace != null) {
1430       permissionBuilder.setNamespaceName(ByteString.copyFromUtf8(namespace));
1431     }
1432     ret.setType(AccessControlProtos.Permission.Type.Namespace)
1433        .setNamespacePermission(permissionBuilder);
1434     return AccessControlProtos.RevokeRequest.newBuilder()
1435       .setUserPermission(
1436           AccessControlProtos.UserPermission.newBuilder()
1437               .setUser(ByteString.copyFromUtf8(username))
1438               .setPermission(ret)
1439       ).build();
1440   }
1441 
1442   /**
1443    * Create a RegionOpenInfo based on given region info and version of offline node
1444    */
1445   private static RegionOpenInfo buildRegionOpenInfo(
1446       final HRegionInfo region, final int versionOfOfflineNode,
1447       final List<ServerName> favoredNodes) {
1448     RegionOpenInfo.Builder builder = RegionOpenInfo.newBuilder();
1449     builder.setRegion(HRegionInfo.convert(region));
1450     if (versionOfOfflineNode >= 0) {
1451       builder.setVersionOfOfflineNode(versionOfOfflineNode);
1452     }
1453     if (favoredNodes != null) {
1454       for (ServerName server : favoredNodes) {
1455         builder.addFavoredNodes(ProtobufUtil.toServerName(server));
1456       }
1457     }
1458     return builder.build();
1459   }
1460 }