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 20 package org.apache.hadoop.hbase.rest; 21 22 import java.io.IOException; 23 24 import org.apache.hadoop.hbase.classification.InterfaceAudience; 25 26 /** 27 * Common interface for models capable of supporting protobuf marshalling 28 * and unmarshalling. Hooks up to the ProtobufMessageBodyConsumer and 29 * ProtobufMessageBodyProducer adapters. 30 */ 31 @InterfaceAudience.Private 32 public interface ProtobufMessageHandler { 33 /** 34 * @return the protobuf represention of the model 35 */ 36 byte[] createProtobufOutput(); 37 38 /** 39 * Initialize the model from a protobuf representation. 40 * @param message the raw bytes of the protobuf message 41 * @return reference to self for convenience 42 * @throws IOException 43 */ 44 ProtobufMessageHandler getObjectFromMessage(byte[] message) 45 throws IOException; 46 }