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
19 package org.apache.hadoop.hbase.ipc;
20
21 import java.io.IOException;
22
23 import org.apache.hadoop.classification.InterfaceAudience;
24 import org.apache.hadoop.classification.InterfaceStability;
25
26 /**
27 * Superclass of all protocols that use Hadoop RPC.
28 * Subclasses of this interface are also supposed to have
29 * a static final long versionID field.
30 */
31 @InterfaceAudience.Public
32 @InterfaceStability.Evolving
33 public interface VersionedProtocol {
34
35 /**
36 * Return protocol version corresponding to protocol interface.
37 * @param protocol The classname of the protocol interface
38 * @param clientVersion The version of the protocol that the client speaks
39 * @return the version that the server will speak
40 * @throws IOException if any IO error occurs
41 */
42 @Deprecated
43 public long getProtocolVersion(String protocol,
44 long clientVersion) throws IOException;
45
46 /**
47 * Return protocol version corresponding to protocol interface.
48 * @param protocol The classname of the protocol interface
49 * @param clientVersion The version of the protocol that the client speaks
50 * @param clientMethodsHash the hashcode of client protocol methods
51 * @return the server protocol signature containing its version and
52 * a list of its supported methods
53 * @see ProtocolSignature#getProtocolSignature(VersionedProtocol, String,
54 * long, int) for a default implementation
55 */
56 public ProtocolSignature getProtocolSignature(String protocol,
57 long clientVersion,
58 int clientMethodsHash) throws IOException;
59 }