クラス BasicAuthenticationEntryPoint

java.lang.ObjectSE
org.springframework.security.web.authentication.www.BasicAuthenticationEntryPoint
実装済みのインターフェース一覧:
org.springframework.beans.factory.InitializingBean, AuthenticationEntryPoint
public class BasicAuthenticationEntryPoint extends ObjectSE implements AuthenticationEntryPoint, org.springframework.beans.factory.InitializingBean
BasicAuthenticationFilter を介して認証を開始するために ExceptionTranslationFilter によって使用されます。

ユーザーエージェントが BASIC 認証を使用して認証されると、ログアウトするにはブラウザーを閉じるか、不正な (401) ヘッダーを送信する必要があります。後者を実現する最も簡単な方法は、以下の commence(HttpServletRequest, HttpServletResponse, AuthenticationException) メソッドを呼び出すことです。これにより、資格情報が承認されなくなったことをブラウザーに示し、ユーザーに再度ログインするように要求します。

  • コンストラクターの詳細

    • BasicAuthenticationEntryPoint

      public BasicAuthenticationEntryPoint()

  • 方法の詳細

    • afterPropertiesSet

      public void afterPropertiesSet()
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean 内の afterPropertiesSet 

    • commence

      public void commence(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, AuthenticationException authException) throws IOExceptionSE
      インターフェースからコピーされた説明: AuthenticationEntryPoint
      認証スキームを開始します。

      ExceptionTranslationFilter は、このメソッドを呼び出す前に、AbstractAuthenticationProcessingFilter.SPRING_SECURITY_SAVED_REQUEST_KEY という名前の HttpSession 属性にリクエストされたターゲット URL を入力します。

      実装では、必要に応じて ServletResponse のヘッダーを変更して、認証プロセスを開始する必要があります。

      次で指定:
      インターフェース AuthenticationEntryPoint 内の commence 
      パラメーター:
      request - AuthenticationException が発生したリクエスト
      response - ユーザーエージェントが認証を開始できるようにする
      authException - 呼び出しの原因となった例外
      例外:
      IOExceptionSE

    • getRealmName

      public @Nullable StringSE getRealmName()

    • setRealmName

      public void setRealmName(StringSE realmName)

    • setCharset

      public void setCharset(@Nullable CharsetSE charset)
      WWW-Authenticate レスポンスヘッダーに含める文字セットを設定します。デフォルトでは StandardCharsets.UTF_8SE に設定されています。ヘッダーから文字セット属性を省略するには、null に設定してください。RFC 7617 に従い、UTF-8 のみが許可されています。
      パラメーター:
      charset - 使用する文字セット（StandardCharsets.UTF_8SE のみが受け入れられる値）、または文字セット属性を削除する null を指定します。
      導入:
      7.1