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.ipc;
20
21 import org.apache.hadoop.classification.InterfaceAudience;
22 import org.apache.hadoop.classification.InterfaceStability;
23
24 /**
25 * All custom RPC protocols to be exported by Coprocessors must extend this interface.
26 *
27 * <p>
28 * <strong>Note that all callable methods must have a return type handled by
29 * {@link org.apache.hadoop.hbase.io.HbaseObjectWritable#writeObject(java.io.DataOutput, Object, Class, org.apache.hadoop.conf.Configuration)}.</strong>
30 * That is:
31 * <ul>
32 * <li>a Java primitive type ({@code int}, {@code float}, etc)</li>
33 * <li>a Java {@code String}</li>
34 * <li>a {@link org.apache.hadoop.io.Writable}</li>
35 * <li>an array or {@code java.util.List} of one of the above</li>
36 * </ul>
37 * </p>
38 * @deprecated since 0.96. Use {@link org.apache.hadoop.hbase.coprocessor.CoprocessorService}
39 * instead.
40 */
41 @InterfaceAudience.Public
42 @InterfaceStability.Evolving
43 @Deprecated
44 public interface CoprocessorProtocol extends VersionedProtocol {
45 public static final long VERSION = 1L;
46 }