SearchableHttpServletResponseWrapper (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.SearchableHttpServletResponseWrapper

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

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, ExtendedServletResponse, ExtendedHttpServletResponse
```
public class SearchableHttpServletResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper
implements ExtendedHttpServletResponse
```
HttpServletResponseWrapperの拡張実装を提供します。このクラスを利用する事により、レスポンスにセットした値を取得可能になり、アプリケーションプログラム内での情報操作の利便性が向上します。

導入されたバージョン:

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

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

コンストラクタ
コンストラクタと説明
`SearchableHttpServletResponseWrapper(javax.servlet.http.HttpServletResponse response)` 指定したレスポンスをラッピングしたレスポンス・アダプタを構築します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`addCookie(javax.servlet.http.Cookie cookie)` このメソッドは、スーパークラスにある `HttpServletResponseWrapper.addCookie(Cookie cookie)` メソッドをそのまま呼び出します。
`void`	`addDateHeader(String name, long date)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.addDateHeader(java.lang.String name, long date)` メソッドをそのまま呼び出します。
`void`	`addHeader(String name, String value)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.addHeader(java.lang.String name, java.lang.String value)` メソッドをそのまま呼び出します。
`void`	`addIntHeader(String name, int value)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.addIntHeader(java.lang.String name, int value)` メソッドをそのまま呼び出します。
`Integer`	`getContentLength()` レスポンスにセットされているメッセージボディ部の長さを返します。
`javax.mail.internet.ContentType`	`getContentTypeObject()` レスポンスにセットされているクライアントに送り返されるレスポンスのコンテントタイプを返します。
`javax.servlet.http.Cookie[]`	`getCookies()` このレスポンスにセットされたすべての Cookie を返します。
`Long`	`getDateHeader(String name)` 指定された名称でレスポンスヘッダに設定されている日付の値を返します。
`long[]`	`getDateHeaders(String name)` 指定された名称でレスポンスヘッダに設定されている全ての日付の値を返します。
`String`	`getHeader(String name)` 指定された名称でレスポンスヘッダに設定されている値を返します。
`Collection<String>`	`getHeaders(String name)` 指定された名称でレスポンスヘッダに設定されている全ての値を返します。
`javax.servlet.http.HttpServletResponse`	`getHttpServletResponse()` このオブジェクトにラップされているレスポンスを返します。
`Integer`	`getIntHeader(String name)` 指定された名称でレスポンスヘッダに設定されている数値を返します。
`int[]`	`getIntHeaders(String name)` 指定された名称でレスポンスヘッダに設定されている全ての数値を返します。
`int`	`getStatus()` レスポンスにセットされているステータスコードを返します。
`String`	`getStringHeader(String name)` 指定された名称でレスポンスヘッダに設定されている文字列の値を返します。
`String[]`	`getStringHeaders(String name)` 指定された名称でレスポンスヘッダに設定されている全ての文字列の値を返します。
`void`	`reset()` このメソッドは、スーパークラスの `ServletResponseWrapper.reset()` メソッドをそのまま呼び出します。
`void`	`sendError(int sc)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.sendError(int)` メソッドをそのまま呼び出します。
`void`	`sendError(int sc, String msg)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.sendError(int, java.lang.String)` メソッドをそのまま呼び出します。
`void`	`sendRedirect(String location)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.sendRedirect(java.lang.String)` メソッドをそのまま呼び出します。
`void`	`setContentLength(int len)` レスポンスのメッセージボディ部分の長さをセットします。
`void`	`setContentType(javax.mail.internet.ContentType type)` このメソッドは、 type の `ContentType.toString()` が返す値をラップしている `ServletResponse` にセットします。
`void`	`setContentType(String type)` クライアントに送り返されるレスポンスのコンテントタイプをセットします。
`void`	`setDateHeader(String name, long date)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.setDateHeader(java.lang.String name, long date)` メソッドをそのまま呼び出します。
`void`	`setHeader(String name, String value)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.setHeader(java.lang.String name, java.lang.String value)` メソッドをそのまま呼び出します。
`void`	`setIntHeader(String name, int value)` このメソッドは、スーパークラスの `HttpServletResponseWrapper.setIntHeader(java.lang.String name, int value)` メソッドをそのまま呼び出します。
`void`	`setStatus(int sc)` このレスポンスのステータスコードを設定します。
`void`	`setStatus(int sc, String sm)` 非推奨です。 `setStatus(int)` を使用してください。エラーメッセージを送信したい場合は、`sendError(int, String)`を使用してください。

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

クラスから継承されたメソッド javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, resetBuffer, setBufferSize, setCharacterEncoding, setLocale, setResponse

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

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

インタフェースから継承されたメソッド javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, resetBuffer, setBufferSize, setCharacterEncoding, setLocale

- コンストラクタの詳細
  - SearchableHttpServletResponseWrapper
```
public SearchableHttpServletResponseWrapper(javax.servlet.http.HttpServletResponse response)
```
    指定したレスポンスをラッピングしたレスポンス・アダプタを構築します。
    
    パラメータ:
    
    response - ラップされるレスポンス・オブジェクト
    
    例外:
    
    IllegalArgumentException - response が null である場合
- メソッドの詳細
  - getHttpServletResponse
```
public javax.servlet.http.HttpServletResponse getHttpServletResponse()
```
    このオブジェクトにラップされているレスポンスを返します。
    
    戻り値:
    
    ラップされているレスポンス
  - addCookie
```
public void addCookie(javax.servlet.http.Cookie cookie)
```
    このメソッドは、スーパークラスにある HttpServletResponseWrapper.addCookie(Cookie cookie) メソッドをそのまま呼び出します。その後、このオブジェクト内に引数 cookie を保持します。保持したオブジェクト cookie は、 getCookies()メソッドによってアプリケーションに返されます。
    
    定義:
    
    addCookie インタフェース内 javax.servlet.http.HttpServletResponse
    
    オーバーライド:
    
    addCookie クラス内 javax.servlet.http.HttpServletResponseWrapper
    
    パラメータ:
    
    cookie - クライアントに返すCookie
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    このレスポンスにセットされたすべての Cookie を返します。 Cookie を１つもセットしていない場合、null を返します。
    
    定義:
    
    getCookies インタフェース内 ExtendedHttpServletResponse
    
    戻り値:
    
    セットされている全ての Cookie
  - addDateHeader
```
public void addDateHeader(String name,
                          long date)
```
    このメソッドは、スーパークラスの HttpServletResponseWrapper.addDateHeader(java.lang.String name, long date) メソッドをそのまま呼び出します。その後、このオブジェクト内に引数 name および date を保持します。保持した情報は、以下のメソッドによってアプリケーションに返されます。
  - getDateHeader(java.lang.String)
  - getDateHeaders(java.lang.String)
  - getHeader(java.lang.String)
  - getHeaders(java.lang.String)

定義:: addDateHeader インタフェース内 javax.servlet.http.HttpServletResponse
オーバーライド:: addDateHeader クラス内 javax.servlet.http.HttpServletResponseWrapper
関連項目:: HttpServletResponse.addDateHeader(java.lang.String, long), HttpServletResponseWrapper.addDateHeader(java.lang.String, long)

setDateHeader
```
public void setDateHeader(String name,
                          long date)
```
このメソッドは、スーパークラスの HttpServletResponseWrapper.setDateHeader(java.lang.String name, long date) メソッドをそのまま呼び出します。その後、このオブジェクト内に引数 name および date を保持します。保持した情報は、以下のメソッドによってアプリケーションに返されます。
getDateHeader(java.lang.String)
getDateHeaders(java.lang.String)
getHeader(java.lang.String)
getHeaders(java.lang.String)

メソッド	返り値の型
`HttpServletResponse.addDateHeader(String name, long date)`	`Long`
`HttpServletResponse.setDateHeader(String name, long date)`	`Long`
`HttpServletResponse.addIntHeader(String name, int value)`	`Integer`
`HttpServletResponse.setIntHeader(String name, int value)`	`Integer`
`HttpServletResponse.addHeader(String name, String value)`	`String`
`HttpServletResponse.setHeader(String name, String value)`	`String`

メソッド

返り値の型

HttpServletResponse.addDateHeader(String name, long date)

Long

HttpServletResponse.setDateHeader(String name, long date)

Long

HttpServletResponse.addIntHeader(String name, int value)

Integer

HttpServletResponse.setIntHeader(String name, int value)

Integer

HttpServletResponse.addHeader(String name, String value)

String

HttpServletResponse.setHeader(String name, String value)

String

クラス SearchableHttpServletResponseWrapper

フィールドのサマリー

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

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

メソッドのサマリー

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

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

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

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

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

コンストラクタの詳細

SearchableHttpServletResponseWrapper

メソッドの詳細

getHttpServletResponse

addCookie

getCookies

addDateHeader

setDateHeader

getDateHeader

getDateHeaders

addIntHeader

setIntHeader

getIntHeader

getIntHeaders

addHeader

setHeader

getStringHeader

getStringHeaders

getHeader

getHeaders

setStatus

setStatus

sendError

sendError

sendRedirect

getStatus

setContentLength

getContentLength

setContentType

getContentTypeObject

setContentType

reset