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.security.token; 20 21 import java.io.IOException; 22 23 import org.apache.hadoop.hbase.ipc.CoprocessorProtocol; 24 import org.apache.hadoop.security.token.Token; 25 26 /** 27 * Defines a custom RPC protocol for obtaining authentication tokens 28 */ 29 public interface AuthenticationProtocol extends CoprocessorProtocol { 30 /** 31 * Obtains a token capable of authenticating as the current user for future 32 * connections. 33 * @return an authentication token for the current user 34 * @throws IOException If obtaining a token is denied or encounters an error 35 */ 36 public Token<AuthenticationTokenIdentifier> getAuthenticationToken() 37 throws IOException; 38 39 /** 40 * Returns the currently authenticated username. 41 */ 42 public String whoami(); 43 }