content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.dolphinscheduler.api.security;
  
  import org.apache.dolphinscheduler.api.utils.Result;
  import org.apache.dolphinscheduler.dao.entity.User;
  
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  
  import lombok.NonNull;
  
  public interface Authenticator {
  
      /**
       * Verifying legality via username and password
       *
       * @param username user name
       * @param password user password
       * @param ip       client ip
       * @return result object
       */
      Result<Map<String, String>> authenticate(@NonNull String username, String password, @NonNull String ip);
  
      /**
       * Get authenticated user
       * @param request http servlet request
       * @return user
       */
      User getAuthUser(HttpServletRequest request);
  }
  