content: /*
   * Copyright 1999-2021 Alibaba Group Holding Ltd.
   *
   * Licensed 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 com.alibaba.nacos.plugin.auth.spi.server;
  
  import com.alibaba.nacos.plugin.auth.api.AuthResult;
  import com.alibaba.nacos.plugin.auth.api.IdentityContext;
  import com.alibaba.nacos.plugin.auth.api.Permission;
  import com.alibaba.nacos.plugin.auth.api.Resource;
  import com.alibaba.nacos.plugin.auth.constant.ActionTypes;
  import com.alibaba.nacos.plugin.auth.exception.AccessException;
  
  import java.util.Collection;
  
  /**
   * Auth service.
   *
   * @author Wuyfee
   * @author xiweng.yy
   */
  public interface AuthPluginService {
      
      /**
       * Define which identity information needed from request. e.q: username, password, accessToken.
       *
       * @return identity names
       */
      Collection<String> identityNames();
      
      /**
       * Judgement whether this plugin enable auth for this action and type.
       *
       * @param action action of request, see {@link ActionTypes}
       * @param type   type of request, see {@link com.alibaba.nacos.plugin.auth.constant.SignType}
       * @return @return {@code true} if enable auth, otherwise {@code false}
       */
      boolean enableAuth(ActionTypes action, String type);
      
      /**
       * To validate whether the identity context from request is legal or illegal.
       *
       * @param identityContext where we can find the user information
       * @param resource        resource about this user information
       * @return {@link AuthResult} of validate result
       * @throws AccessException if authentication is failed
       */
      AuthResult validateIdentity(IdentityContext identityContext, Resource resource) throws AccessException;
      
      /**
       * Validate the identity whether has the resource authority.
       *
       * @param identityContext where we can find the user information.
       * @param permission      permission to auth.
       * @return {@link AuthResult} of validate result
       * @throws AccessException if authentication is failed
       */
      AuthResult validateAuthority(IdentityContext identityContext, Permission permission) throws AccessException;
      
      /**
       * AuthPluginService Name which for conveniently find AuthPluginService instance.
       *
       * @return AuthServiceName mark a AuthPluginService instance.
       */
      String getAuthServiceName();
      
      /**
       * Is the plugin enable login.
       *
       * @return {@code true} if plugin need login, otherwise {@code false}
       * @since 2.2.2
       */
      default boolean isLoginEnabled() {
          return false;
      }
      
      /**
       * Whether need administrator .
       *
       * @return if need the administrator role.
       */
      default boolean isAdminRequest() {
          return true;
      }
  }
  