View Javadoc

1   /*
2    * Copyright 2010 The Apache Software Foundation
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  
21  package org.apache.hadoop.hbase.rest;
22  
23  import java.io.IOException;
24  
25  /**
26   * Common interface for models capable of supporting protobuf marshalling
27   * and unmarshalling. Hooks up to the ProtobufMessageBodyConsumer and
28   * ProtobufMessageBodyProducer adapters. 
29   */
30  public abstract interface ProtobufMessageHandler {
31    /**
32     * @return the protobuf represention of the model
33     */
34    public byte[] createProtobufOutput();
35  
36    /**
37     * Initialize the model from a protobuf representation.
38     * @param message the raw bytes of the protobuf message
39     * @return reference to self for convenience
40     * @throws IOException
41     */
42    public ProtobufMessageHandler getObjectFromMessage(byte[] message)
43      throws IOException;
44  }