service/auth/PasswdAuthenticationProvider.java

0001 /**
0002  * Licensed to the Apache Software Foundation (ASF) under one
0003  * or more contributor license agreements.  See the NOTICE file
0004  * distributed with this work for additional information
0005  * regarding copyright ownership.  The ASF licenses this file
0006  * to you under the Apache License, Version 2.0 (the
0007  * "License"); you may not use this file except in compliance
0008  * with the License.  You may obtain a copy of the License at
0009  *
0010  *     http://www.apache.org/licenses/LICENSE-2.0
0011  *
0012  * Unless required by applicable law or agreed to in writing, software
0013  * distributed under the License is distributed on an "AS IS" BASIS,
0014  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0015  * See the License for the specific language governing permissions and
0016  * limitations under the License.
0017  */
0018 package org.apache.hive.service.auth;
0019
0020 import javax.security.sasl.AuthenticationException;
0021
0022 public interface PasswdAuthenticationProvider {
0023
0024   /**
0025    * The Authenticate method is called by the HiveServer2 authentication layer
0026    * to authenticate users for their requests.
0027    * If a user is to be granted, return nothing/throw nothing.
0028    * When a user is to be disallowed, throw an appropriate {@link AuthenticationException}.
0029    *
0030    * For an example implementation, see {@link LdapAuthenticationProviderImpl}.
0031    *
0032    * @param user     The username received over the connection request
0033    * @param password The password received over the connection request
0034    *
0035    * @throws AuthenticationException When a user is found to be
0036    *                                 invalid by the implementation
0037    */
0038   void Authenticate(String user, String password) throws AuthenticationException;
0039 }