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 */
019
020package org.apache.hadoop.hbase.rest;
021
022import java.io.IOException;
023
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * Common interface for models capable of supporting protobuf marshalling
028 * and unmarshalling. Hooks up to the ProtobufMessageBodyConsumer and
029 * ProtobufMessageBodyProducer adapters. 
030 */
031@InterfaceAudience.Private
032public interface ProtobufMessageHandler {
033  /**
034   * @return the protobuf represention of the model
035   */
036  byte[] createProtobufOutput();
037
038  /**
039   * Initialize the model from a protobuf representation.
040   * @param message the raw bytes of the protobuf message
041   * @return reference to self for convenience
042   * @throws IOException
043   */
044  ProtobufMessageHandler getObjectFromMessage(byte[] message)
045    throws IOException;
046}