AbstractHttpServletResponseEventController (javadoc-all-dev 8.0.0 API)

java.lang.Object
- javax.servlet.ServletResponseWrapper
- - javax.servlet.http.HttpServletResponseWrapper
  - - jp.co.intra_mart.common.aid.jsdk.javax.servlet.http.ExtendedHttpServletResponseWrapper
    - - jp.co.intra_mart.common.aid.jsdk.javax.servlet.filter.AbstractHttpServletResponseEventController

すべての実装されたインタフェース:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, ExtendedServletResponse, HttpServletResponseEventController, ExtendedHttpServletResponse
```
public abstract class AbstractHttpServletResponseEventController
extends ExtendedHttpServletResponseWrapper
implements HttpServletResponseEventController
```
イベントを制御するレスポンスの抽象実装です。
HttpServletResponse が持つ各メソッド（非推奨を除く）をオーバーライドして、リスナに処理を委任するロジックを追加します。

導入されたバージョン:

Version 6.0

フィールドのサマリー
- インタフェースから継承されたフィールド 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

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

コンストラクタ
コンストラクタと説明

AbstractHttpServletResponseEventController(ExtendedHttpServletResponse response)
新しいインスタンスを生成します。

コンストラクタ
コンストラクタと説明
`AbstractHttpServletResponseEventController(ExtendedHttpServletResponse response)` 新しいインスタンスを生成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addCookie(javax.servlet.http.Cookie cookie)` 指定されたCookieをレスポンスに追加します。
`void`	`addDateHeader(String name, long date)` 指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。
`void`	`addHeader(String name, String value)` 指定された名称で指定された値を持つレスポンスヘッダを追加します。
`void`	`addIntHeader(String name, int value)` 指定された名称で指定された整数値を持つレスポンスヘッダを追加します。
`boolean`	`containsHeader(String name)` 指定された名前を持つヘッダが既にセットされているかどうかを表す booleanを返します。
`String`	`encodeRedirectURL(String url)` `sendRedirect(String)` メソッドの中で使えるように、指定されたURLをエンコードします。
`String`	`encodeURL(String url)` 指定されたURLがセッションIDを含むようにエンコードします。
`void`	`flushBuffer()` バッファリングされているコンテンツを強制的にクライアントに出力します。
`int`	`getBufferSize()` このレスポンスに設定されている実バッファサイズを返します。
`String`	`getCharacterEncoding()` このレスポンスで送り返す MIME ボディに適用されている文字エンコーディング名を返します。
`protected abstract javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()` リクエストを返します。
`protected abstract HttpServletResponseEventListener`	`getHttpServletResponseEventListener()` リスナを返します。
`Locale`	`getLocale(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)` レスポンスに設定されているロケールを返します。
`javax.servlet.ServletOutputStream`	`getOutputStream()` レスポンスにバイナリデータを出力する際に使用する `ServletOutputStream`型のオブジェクトを返します。
`PrintWriter`	`getWriter()` 文字データをクライアントに送り返すのに使用する `PrintWriter`オブジェクトを返します。
`protected void`	`handleInit()` このリスナを初期化します。
`void`	`init(HttpServletResponseEventConfig config)` このビルダを初期化します。
`boolean`	`isCommitted()` レスポンスがすでにコミットされたかどうかを示す boolean を返します。
`void`	`reset()` バッファリングされているデータ、ステータスコードとヘッダフィールドの値を削除します。
`void`	`resetBuffer()` レスポンスのヘッダフィールドの値やステータスコードをそのままにしてバッファに溜められているコンテンツを消去します。
`void`	`sendError(int sc)` バッファをクリアし、指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
`void`	`sendError(int sc, String msg)` バッファをクリアし、指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
`void`	`sendRedirect(String location)` 指定されたリダイレクト先のURLを用いて、クライアントに一時的なリダイレクトレスポンスを送信します。
`void`	`setBufferSize(int size)` 適当なバッファサイズをレスポンスに含まれるメッセージボディのサイズに設定します。
`void`	`setContentLength(int len)` レスポンスのメッセージボディ部分の長さをセットします。
`void`	`setContentType(String type)` クライアントに送り返されるレスポンスのコンテントタイプをセットします。
`void`	`setDateHeader(String name, long date)` 指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。
`void`	`setHeader(String name, String value)` 指定された名称で指定された値を持つレスポンスヘッダを設定します。
`void`	`setIntHeader(String name, int value)` 指定された名称で指定された整数値を持つレスポンスヘッダを設定します。
`void`	`setLocale(Locale loc)` レスポンスのロケールをセットしますが、このとき(Content-Type で指定する文字エンコーディングを含む)ヘッダも適当な値にセットします。
`void`	`setStatus(int sc)` このレスポンスのステータスコードを設定します。

クラスから継承されたメソッド jp.co.intra_mart.common.aid.jsdk.javax.servlet.http.ExtendedHttpServletResponseWrapper
getContentLength, getContentTypeObject, getCookies, getDateHeader, getDateHeaders, getExtendedHttpServletResponse, getHeader, getHeaders, getIntHeader, getIntHeaders, getStatus, getStringHeader, getStringHeaders, setContentType

クラスから継承されたメソッド javax.servlet.http.HttpServletResponseWrapper
encodeRedirectUrl, encodeUrl, setStatus

クラスから継承されたメソッド javax.servlet.ServletResponseWrapper
getContentType, getLocale, getResponse, setCharacterEncoding, setResponse

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド jp.co.intra_mart.common.aid.jsdk.javax.servlet.http.ExtendedHttpServletResponse
getCookies, getDateHeader, getDateHeaders, getHeader, getHeaders, getIntHeader, getIntHeaders, getStatus, getStringHeader, getStringHeaders

インタフェースから継承されたメソッド jp.co.intra_mart.common.aid.jsdk.javax.servlet.ExtendedServletResponse
getContentLength, getContentTypeObject, setContentType

インタフェースから継承されたメソッド javax.servlet.http.HttpServletResponse
encodeRedirectUrl, encodeUrl, setStatus

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

- コンストラクタの詳細
  - AbstractHttpServletResponseEventController
```
public AbstractHttpServletResponseEventController(ExtendedHttpServletResponse response)
```
    新しいインスタンスを生成します。
- メソッドの詳細
  - handleInit
```
protected void handleInit()
                   throws HttpServletResponseEventControllerException
```
    このリスナを初期化します。
    このメソッドは、#init(HttpServletResponseEventListenerConfig) によって呼び出されます。このメソッドは単にリターンするだけで、何もしません。
    サブクラスが初期化処理を必要とする場合、このメソッドをオーバーライドしてください。
    
    例外:
    
    HttpServletResponseEventControllerException - 初期化に失敗した場合
  - getHttpServletRequest
```
protected abstract javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
    リクエストを返します。
    
    戻り値:
    
    現在のリクエスト
  - getHttpServletResponseEventListener
```
protected abstract HttpServletResponseEventListener getHttpServletResponseEventListener()
```
    リスナを返します。
    
    戻り値:
    
    リスナ
  - init
```
public final void init(HttpServletResponseEventConfig config)
                throws HttpServletResponseEventControllerException
```
    このビルダを初期化します。
    
    定義:
    
    init インタフェース内 HttpServletResponseEventController
    
    パラメータ:
    
    config - 初期化パラメータ
    
    例外:
    
    HttpServletResponseEventControllerException - 初期化に失敗した場合
  - addCookie
```
public void addCookie(javax.servlet.http.Cookie cookie)
```
    指定されたCookieをレスポンスに追加します。
    
    定義:
    
    addCookie インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    addCookie クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    cookie - クライアントに返すCookie
  - containsHeader
```
public boolean containsHeader(String name)
```
    指定された名前を持つヘッダが既にセットされているかどうかを表す booleanを返します。
    
    定義:
    
    containsHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    containsHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - ヘッダ名
    
    戻り値:
    
    指定された名前のレスポンスヘッダが既にセットされていれば true、そうでなければfalse
  - encodeURL
```
public String encodeURL(String url)
```
    指定されたURLがセッションIDを含むようにエンコードします。
    
    定義:
    
    encodeURL インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    encodeURL クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    url - エンコードするURL
    
    戻り値:
    
    エンコードが必要である場合、エンコードされたURL。そうでない場合は与えられたそのままのURL
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    sendRedirect(String) メソッドの中で使えるように、指定されたURLをエンコードします。
    
    定義:
    
    encodeRedirectURL インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    encodeRedirectURL クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    url - エンコードするURL
    
    戻り値:
    
    エンコードが必要である場合、エンコードされたURL。そうでない場合は与えられたそのままのURL
  - sendError
```
public void sendError(int sc,
                      String msg)
               throws IOException
```
    バッファをクリアし、指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
    
    定義:
    
    sendError インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    sendError クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    sc - エラーステータスコード
    
    msg - 説明文
    
    例外:
    
    IOException - 入出力例外が発生した場合
    
    IllegalStateException - レスポンスが既にコミットされている場合
  - sendError
```
public void sendError(int sc)
               throws IOException
```
    バッファをクリアし、指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
    
    定義:
    
    sendError インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    sendError クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    sc - エラーステータスコード
    
    例外:
    
    IOException - 入出力例外が発生した場合
    
    IllegalStateException - レスポンスが既にコミットされている場合
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    指定されたリダイレクト先のURLを用いて、クライアントに一時的なリダイレクトレスポンスを送信します。
    
    定義:
    
    sendRedirect インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    sendRedirect クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    location - リダイレクト先のURL
    
    例外:
    
    IOException - 入出力例外が発生した場合
    
    IllegalStateException - レスポンスが既にコミットされている場合
  - setDateHeader
```
public void setDateHeader(String name,
                          long date)
```
    指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。
    
    定義:
    
    setDateHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    setDateHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - 設定するヘッダの名称
    
    date - 設定するヘッダの値
  - addDateHeader
```
public void addDateHeader(String name,
                          long date)
```
    指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。
    
    定義:
    
    addDateHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    addDateHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - 追加するヘッダの名称
    
    date - 追加するヘッダの値
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    指定された名称で指定された値を持つレスポンスヘッダを設定します。
    
    定義:
    
    setHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    setHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - ヘッダの名称
    
    value - ヘッダの値
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    指定された名称で指定された値を持つレスポンスヘッダを追加します。
    
    定義:
    
    addHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    addHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - ヘッダの名称
    
    value - 追加するヘッダの値
  - setIntHeader
```
public void setIntHeader(String name,
                         int value)
```
    指定された名称で指定された整数値を持つレスポンスヘッダを設定します。
    
    定義:
    
    setIntHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    setIntHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - ヘッダの名称
    
    value - 割り当てられる整数値
  - addIntHeader
```
public void addIntHeader(String name,
                         int value)
```
    指定された名称で指定された整数値を持つレスポンスヘッダを追加します。
    
    定義:
    
    addIntHeader インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    addIntHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    name - ヘッダの名称
    
    value - 割り当てられる整数値
  - setStatus
```
public void setStatus(int sc)
```
    このレスポンスのステータスコードを設定します。
    
    定義:
    
    setStatus インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    setStatus クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    sc - ステータスコード
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    このレスポンスで送り返す MIME ボディに適用されている文字エンコーディング名を返します。
    
    定義:
    
    getCharacterEncoding インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    getCharacterEncoding クラス内 javax.servlet.ServletResponseWrapper
    
    戻り値:
    
    文字エンコーディング名を意味する String。
  - getOutputStream
```
public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException
```
    レスポンスにバイナリデータを出力する際に使用する ServletOutputStream型のオブジェクトを返します。
    
    定義:
    
    getOutputStream インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    getOutputStream クラス内 javax.servlet.ServletResponseWrapper
    
    戻り値:
    
    バイナリデータ出力に使用する ServletOutputStream
    
    例外:
    
    IllegalStateException - このレスポンスですでに getWriter() メソッドが実行されていた場合
    
    IOException - 入出力時に例外が発生した場合
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    文字データをクライアントに送り返すのに使用する PrintWriterオブジェクトを返します。
    
    定義:
    
    getWriter インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    getWriter クラス内 javax.servlet.ServletResponseWrapper
    
    戻り値:
    
    クライアントに文字データを送り返すことができる PrintWriter オブジェクト
    
    例外:
    
    UnsupportedEncodingException - setContentType メソッドで指定された文字エンコーディングがサポートされていない場合
    
    IllegalStateException - このレスポンスですでに getOutputStream() メソッドが実行されていた場合
    
    IOException - 入出力時に例外が発生した場合
  - setContentLength
```
public void setContentLength(int len)
```
    レスポンスのメッセージボディ部分の長さをセットします。
    
    定義:
    
    setContentLength インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    setContentLength クラス内 javax.servlet.ServletResponseWrapper
    
    パラメータ:
    
    len - クライアントに送り返すメッセージボディの長さを指定する整数値。
  - setContentType
```
public void setContentType(String type)
```
    クライアントに送り返されるレスポンスのコンテントタイプをセットします。
    
    定義:
    
    setContentType インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    setContentType クラス内 javax.servlet.ServletResponseWrapper
    
    パラメータ:
    
    type - コンテントタイプを指定する String
  - setBufferSize
```
public void setBufferSize(int size)
```
    適当なバッファサイズをレスポンスに含まれるメッセージボディのサイズに設定します。
    
    定義:
    
    setBufferSize インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    setBufferSize クラス内 javax.servlet.ServletResponseWrapper
    
    パラメータ:
    
    size - 適当なバッファサイズを指定する整数値
    
    例外:
    
    IllegalStateException - すでにコンテンツが出力された後でこのメソッドが実行された場合
  - getBufferSize
```
public int getBufferSize()
```
    このレスポンスに設定されている実バッファサイズを返します。
    
    定義:
    
    getBufferSize インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    getBufferSize クラス内 javax.servlet.ServletResponseWrapper
    
    戻り値:
    
    実際に使われているバッファサイズ
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    バッファリングされているコンテンツを強制的にクライアントに出力します。
    
    定義:
    
    flushBuffer インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    flushBuffer クラス内 javax.servlet.ServletResponseWrapper
    
    例外:
    
    IOException - 入出力時に例外が発生した場合
  - resetBuffer
```
public void resetBuffer()
```
    レスポンスのヘッダフィールドの値やステータスコードをそのままにしてバッファに溜められているコンテンツを消去します。
    
    定義:
    
    resetBuffer インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    resetBuffer クラス内 javax.servlet.ServletResponseWrapper
  - isCommitted
```
public boolean isCommitted()
```
    レスポンスがすでにコミットされたかどうかを示す boolean を返します。
    
    定義:
    
    isCommitted インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    isCommitted クラス内 javax.servlet.ServletResponseWrapper
    
    戻り値:
    
    レスポンスがすでにコミットされたかどうかを示す boolean
  - reset
```
public void reset()
```
    バッファリングされているデータ、ステータスコードとヘッダフィールドの値を削除します。
    
    定義:
    
    reset インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    reset クラス内 javax.servlet.ServletResponseWrapper
  - setLocale
```
public void setLocale(Locale loc)
```
    レスポンスのロケールをセットしますが、このとき(Content-Type で指定する文字エンコーディングを含む)ヘッダも適当な値にセットします。
    
    定義:
    
    setLocale インタフェース内 javax.servlet.ServletResponse
    
    オーバーライド:
    
    setLocale クラス内 javax.servlet.ServletResponseWrapper
    
    パラメータ:
    
    loc - レスポンスのロケールを指定する Locale オブジェクト
  - getLocale
```
public Locale getLocale(javax.servlet.http.HttpServletRequest request,
                        ExtendedHttpServletResponse response)
```
    レスポンスに設定されているロケールを返します。
    
    戻り値:
    
    レスポンスに設定されているロケール

クラス AbstractHttpServletResponseEventController

フィールドのサマリー

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

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

メソッドのサマリー

クラスから継承されたメソッド jp.co.intra_mart.common.aid.jsdk.javax.servlet.http.ExtendedHttpServletResponseWrapper

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

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

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

インタフェースから継承されたメソッド jp.co.intra_mart.common.aid.jsdk.javax.servlet.http.ExtendedHttpServletResponse

インタフェースから継承されたメソッド jp.co.intra_mart.common.aid.jsdk.javax.servlet.ExtendedServletResponse

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

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

コンストラクタの詳細

AbstractHttpServletResponseEventController

メソッドの詳細

handleInit

getHttpServletRequest

getHttpServletResponseEventListener

init

addCookie

containsHeader

encodeURL

encodeRedirectURL

sendError

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

getCharacterEncoding

getOutputStream

getWriter

setContentLength

setContentType

setBufferSize

getBufferSize

flushBuffer

resetBuffer

isCommitted

reset

setLocale

getLocale