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

クラス OnCommittedResponseWrapper

  • 実装されたすべてのインターフェース:
    javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
    既知の直属サブクラス
    SaveContextOnUpdateOrErrorResponseWrapper
    public abstract class OnCommittedResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper
    HttpServletResponse がコミットされたときにイベントを処理するためのロジックをカプセル化するレスポンスラッパーの基本クラス。
    導入:
    4.0.2

    • フィールドサマリー

      • インターフェース javax.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_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_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_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      OnCommittedResponseWrapper​(javax.servlet.http.HttpServletResponse response)

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド   具象メソッド  
      修飾子と型 メソッド 説明
      voidaddHeader​(java.lang.String name, java.lang.String value)
      protected voiddisableOnResponseCommitted()
      このメソッドを呼び出して、HttpServletResponse がコミットされたときの onResponseCommitted() の呼び出しを無効にします。
      voidflushBuffer()
      スーパークラス flushBuffer() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
      javax.servlet.ServletOutputStreamgetOutputStream()
      呼び出し側の getOutputStream().close() または getOutputStream().flush() を呼び出す前に、onResponseCommitted() が呼び出されていることを確認します
      java.io.PrintWritergetWriter()
      getWriter().close() または getWriter().flush() を呼び出す前に onResponseCommitted() が呼び出されていることを確認します
      protected booleanisDisableOnResponseCommitted()
      レスポンスがコミットされたときに onResponseCommitted() が呼び出される場合は true、それ以外の場合は false を返します。
      protected abstract voidonResponseCommitted()
      コミットされる HttpServletResponse を処理するためのロジックを実装する
      voidsendError​(int sc)
      スーパークラス sendError() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
      voidsendError​(int sc, java.lang.String msg)
      スーパークラス sendError() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
      voidsendRedirect​(java.lang.String location)
      スーパークラス sendRedirect() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
      voidsetContentLength​(int len)
      voidsetContentLengthLong​(long len)

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

        addCookie, addDateHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, setDateHeader, setHeader, setIntHeader, setStatus, setStatus, setTrailerFields

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

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

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

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

      • OnCommittedResponseWrapper

        public OnCommittedResponseWrapper​(javax.servlet.http.HttpServletResponse response)
        パラメーター:
        response - ラップされるレスポンス

    • メソッドの詳細

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.String value)
        次で指定:
        インターフェース javax.servlet.http.HttpServletResponse の addHeader 
        オーバーライド:
        クラス javax.servlet.http.HttpServletResponseWrapper の addHeader 

      • setContentLength

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

      • setContentLengthLong

        public void setContentLengthLong​(long len)
        次で指定:
        インターフェース javax.servlet.ServletResponse の setContentLengthLong 
        オーバーライド:
        クラス javax.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 java.io.IOException
        スーパークラス sendError() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
        次で指定:
        インターフェース javax.servlet.http.HttpServletResponse の sendError 
        オーバーライド:
        クラス javax.servlet.http.HttpServletResponseWrapper の sendError 
        例外:
        java.io.IOException

      • sendError

        public final void sendError​(int sc,
                            java.lang.String msg)
                     throws java.io.IOException
        スーパークラス sendError() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
        次で指定:
        インターフェース javax.servlet.http.HttpServletResponse の sendError 
        オーバーライド:
        クラス javax.servlet.http.HttpServletResponseWrapper の sendError 
        例外:
        java.io.IOException

      • sendRedirect

        public final void sendRedirect​(java.lang.String location)
                        throws java.io.IOException
        スーパークラス sendRedirect() を呼び出す前に onResponseCommitted() が呼び出されることを確認します
        次で指定:
        インターフェース javax.servlet.http.HttpServletResponse の sendRedirect 
        オーバーライド:
        クラス javax.servlet.http.HttpServletResponseWrapper の sendRedirect 
        例外:
        java.io.IOException

      • getOutputStream

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

      • getWriter

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

      • flushBuffer

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