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