パッケージ org.springframework.security.web.util

クラス OnCommittedResponseWrapper

java.lang.ObjectSE
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
org.springframework.security.web.util.OnCommittedResponseWrapper
実装済みのインターフェース一覧:
jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
既知の直属サブクラス
SaveContextOnUpdateOrErrorResponseWrapper
public abstract class OnCommittedResponseWrapper extends jakarta.servlet.http.HttpServletResponseWrapper
HttpServletResponse がコミットされたときにイベントを処理するためのロジックをカプセル化するレスポンスラッパーの基本クラス。
導入:
4.0.2

  • フィールド概要

    インターフェース jakarta.servlet.http.HttpServletResponse から継承されたフィールド

    SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MISDIRECTED_REQUEST, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PERMANENT_REDIRECT, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY

  • コンストラクター概要

    コンストラクター
    コンストラクター
    説明
    OnCommittedResponseWrapper(jakarta.servlet.http.HttpServletResponse response)
    新しいインスタンスを作成します。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    addHeader(@Nullable StringSE name, @Nullable StringSE value)
    void
    addIntHeader(@Nullable StringSE name, int value)
    protected void
    disableOnResponseCommitted()
    このメソッドを呼び出して、HttpServletResponse がコミットされたときの onResponseCommitted() の呼び出しを無効にします。
    void
    flushBuffer()
    スーパークラス flushBuffer() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
    jakarta.servlet.ServletOutputStream
    getOutputStream()
    getOutputStream().close() または getOutputStream().flush() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
    PrintWriterSE
    getWriter()
    getWriter().close() または getWriter().flush() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
    protected boolean
    isDisableOnResponseCommitted()
    レスポンスがコミットされたときに onResponseCommitted() が呼び出される場合は true、それ以外の場合は false を返します。
    protected abstract void
    onResponseCommitted()
    コミットされる HttpServletResponse を処理するロジックを実装してください。
    final void
    sendError(int sc)
    スーパークラス sendError() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
    final void
    sendError(int sc, @Nullable StringSE msg)
    スーパークラス sendError() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
    final void
    sendRedirect(@Nullable StringSE location)
    スーパークラス sendRedirect() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
    void
    setContentLength(int len)
    void
    setContentLengthLong(long len)
    void
    setHeader(@Nullable StringSE name, @Nullable StringSE value)
    void
    setIntHeader(@Nullable StringSE name, int value)

    クラス jakarta.servlet.http.HttpServletResponseWrapper から継承されたメソッド

    addCookie, addDateHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendRedirect, sendRedirect, sendRedirect, setDateHeader, setStatus, setTrailerFields

    クラス jakarta.servlet.ServletResponseWrapper から継承されたメソッド

    getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setCharacterEncoding, setContentType, setLocale, setResponse

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

    インターフェース jakarta.servlet.ServletResponse から継承されたメソッド

    getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setCharacterEncoding, setContentType, setLocale

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

    • OnCommittedResponseWrapper

      public OnCommittedResponseWrapper(jakarta.servlet.http.HttpServletResponse response)
      新しいインスタンスを作成します。
      パラメーター:
      response - ラップされるレスポンス

  • 方法の詳細

    • addHeader

      public void addHeader(@Nullable StringSE name, @Nullable StringSE value)
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の addHeader 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の addHeader 

    • addIntHeader

      public void addIntHeader(@Nullable StringSE name, int value)
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の addIntHeader 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の addIntHeader 

    • setHeader

      public void setHeader(@Nullable StringSE name, @Nullable StringSE value)
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の setHeader 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の setHeader 

    • setIntHeader

      public void setIntHeader(@Nullable StringSE name, int value)
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の setIntHeader 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の setIntHeader 

    • setContentLength

      public void setContentLength(int len)
      次で指定:
      インターフェース jakarta.servlet.ServletResponse 内の setContentLength 
      オーバーライド:
      クラス jakarta.servlet.ServletResponseWrapper の setContentLength 

    • setContentLengthLong

      public void setContentLengthLong(long len)
      次で指定:
      インターフェース jakarta.servlet.ServletResponse 内の setContentLengthLong 
      オーバーライド:
      クラス jakarta.servlet.ServletResponseWrapper の setContentLengthLong 

    • disableOnResponseCommitted

      protected void disableOnResponseCommitted()
      このメソッドを呼び出して、HttpServletResponse がコミットされたときの onResponseCommitted() の呼び出しを無効にします。これは、非同期 Web リクエストが行われた場合に役立ちます。

    • isDisableOnResponseCommitted

      protected boolean isDisableOnResponseCommitted()
      レスポンスがコミットされたときに onResponseCommitted() が呼び出される場合は true、それ以外の場合は false を返します。
      戻り値:
      onResponseCommitted() が有効な場合

    • onResponseCommitted

      protected abstract void onResponseCommitted()
      コミットされる HttpServletResponse を処理するロジックを実装してください。

    • sendError

      public final void sendError(int sc) throws IOExceptionSE
      スーパークラス sendError() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の sendError 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の sendError 
      例外:
      IOExceptionSE

    • sendError

      public final void sendError(int sc, @Nullable StringSE msg) throws IOExceptionSE
      スーパークラス sendError() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の sendError 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の sendError 
      例外:
      IOExceptionSE

    • sendRedirect

      public final void sendRedirect(@Nullable StringSE location) throws IOExceptionSE
      スーパークラス sendRedirect() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
      次で指定:
      インターフェース jakarta.servlet.http.HttpServletResponse 内の sendRedirect 
      オーバーライド:
      クラス jakarta.servlet.http.HttpServletResponseWrapper の sendRedirect 
      例外:
      IOExceptionSE

    • getOutputStream

      public jakarta.servlet.ServletOutputStream getOutputStream() throws IOExceptionSE
      getOutputStream().close() または getOutputStream().flush() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
      次で指定:
      インターフェース jakarta.servlet.ServletResponse 内の getOutputStream 
      オーバーライド:
      クラス jakarta.servlet.ServletResponseWrapper の getOutputStream 
      例外:
      IOExceptionSE

    • getWriter

      public PrintWriterSE getWriter() throws IOExceptionSE
      getWriter().close() または getWriter().flush() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
      次で指定:
      インターフェース jakarta.servlet.ServletResponse 内の getWriter 
      オーバーライド:
      クラス jakarta.servlet.ServletResponseWrapper の getWriter 
      例外:
      IOExceptionSE

    • flushBuffer

      public void flushBuffer() throws IOExceptionSE
      スーパークラス flushBuffer() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します。
      次で指定:
      インターフェース jakarta.servlet.ServletResponse 内の flushBuffer 
      オーバーライド:
      クラス jakarta.servlet.ServletResponseWrapper の flushBuffer 
      例外:
      IOExceptionSE