public abstract class AbstractHttpServletResponseEventController extends ExtendedHttpServletResponseWrapper implements HttpServletResponseEventController
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)
新しいインスタンスを生成します。
|
修飾子とタイプ | メソッドと説明 |
---|---|
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)
このレスポンスのステータスコードを設定します。
|
getContentLength, getContentTypeObject, getCookies, getDateHeader, getDateHeaders, getExtendedHttpServletResponse, getHeader, getHeaders, getIntHeader, getIntHeaders, getStatus, getStringHeader, getStringHeaders, setContentType
encodeRedirectUrl, encodeUrl, setStatus
getContentType, getLocale, getResponse, setCharacterEncoding, setResponse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCookies, getDateHeader, getDateHeaders, getHeader, getHeaders, getIntHeader, getIntHeaders, getStatus, getStringHeader, getStringHeaders
getContentLength, getContentTypeObject, setContentType
public AbstractHttpServletResponseEventController(ExtendedHttpServletResponse response)
protected void handleInit() throws HttpServletResponseEventControllerException
このメソッドは、#init(HttpServletResponseEventListenerConfig)
によって呼び出されます。 このメソッドは単にリターンするだけで、何もしません。
サブクラスが初期化処理を必要とする場合、 このメソッドをオーバーライドしてください。
HttpServletResponseEventControllerException
- 初期化に失敗した場合protected abstract javax.servlet.http.HttpServletRequest getHttpServletRequest()
protected abstract HttpServletResponseEventListener getHttpServletResponseEventListener()
public final void init(HttpServletResponseEventConfig config) throws HttpServletResponseEventControllerException
init
インタフェース内 HttpServletResponseEventController
config
- 初期化パラメータHttpServletResponseEventControllerException
- 初期化に失敗した場合public void addCookie(javax.servlet.http.Cookie cookie)
addCookie
インタフェース内 javax.servlet.http.HttpServletResponse
addCookie
クラス内 javax.servlet.http.HttpServletResponseWrapper
cookie
- クライアントに返すCookiepublic boolean containsHeader(String name)
containsHeader
インタフェース内 javax.servlet.http.HttpServletResponse
containsHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- ヘッダ名public String encodeURL(String url)
encodeURL
インタフェース内 javax.servlet.http.HttpServletResponse
encodeURL
クラス内 javax.servlet.http.HttpServletResponseWrapper
url
- エンコードするURLpublic String encodeRedirectURL(String url)
sendRedirect(String)
メソッドの中で使えるように、 指定されたURLをエンコードします。encodeRedirectURL
インタフェース内 javax.servlet.http.HttpServletResponse
encodeRedirectURL
クラス内 javax.servlet.http.HttpServletResponseWrapper
url
- エンコードするURLpublic void sendError(int sc, String msg) throws IOException
sendError
インタフェース内 javax.servlet.http.HttpServletResponse
sendError
クラス内 javax.servlet.http.HttpServletResponseWrapper
sc
- エラーステータスコードmsg
- 説明文IOException
- 入出力例外が発生した場合IllegalStateException
- レスポンスが既にコミットされている場合public void sendError(int sc) throws IOException
sendError
インタフェース内 javax.servlet.http.HttpServletResponse
sendError
クラス内 javax.servlet.http.HttpServletResponseWrapper
sc
- エラーステータスコードIOException
- 入出力例外が発生した場合IllegalStateException
- レスポンスが既にコミットされている場合public void sendRedirect(String location) throws IOException
sendRedirect
インタフェース内 javax.servlet.http.HttpServletResponse
sendRedirect
クラス内 javax.servlet.http.HttpServletResponseWrapper
location
- リダイレクト先のURLIOException
- 入出力例外が発生した場合IllegalStateException
- レスポンスが既にコミットされている場合public void setDateHeader(String name, long date)
setDateHeader
インタフェース内 javax.servlet.http.HttpServletResponse
setDateHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- 設定するヘッダの名称date
- 設定するヘッダの値public void addDateHeader(String name, long date)
addDateHeader
インタフェース内 javax.servlet.http.HttpServletResponse
addDateHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- 追加するヘッダの名称date
- 追加するヘッダの値public void setHeader(String name, String value)
setHeader
インタフェース内 javax.servlet.http.HttpServletResponse
setHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- ヘッダの名称value
- ヘッダの値public void addHeader(String name, String value)
addHeader
インタフェース内 javax.servlet.http.HttpServletResponse
addHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- ヘッダの名称value
- 追加するヘッダの値public void setIntHeader(String name, int value)
setIntHeader
インタフェース内 javax.servlet.http.HttpServletResponse
setIntHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- ヘッダの名称value
- 割り当てられる整数値public void addIntHeader(String name, int value)
addIntHeader
インタフェース内 javax.servlet.http.HttpServletResponse
addIntHeader
クラス内 javax.servlet.http.HttpServletResponseWrapper
name
- ヘッダの名称value
- 割り当てられる整数値public void setStatus(int sc)
setStatus
インタフェース内 javax.servlet.http.HttpServletResponse
setStatus
クラス内 javax.servlet.http.HttpServletResponseWrapper
sc
- ステータスコードpublic String getCharacterEncoding()
getCharacterEncoding
インタフェース内 javax.servlet.ServletResponse
getCharacterEncoding
クラス内 javax.servlet.ServletResponseWrapper
public javax.servlet.ServletOutputStream getOutputStream() throws IOException
ServletOutputStream
型のオブジェクトを返します。getOutputStream
インタフェース内 javax.servlet.ServletResponse
getOutputStream
クラス内 javax.servlet.ServletResponseWrapper
ServletOutputStream
IllegalStateException
- このレスポンスですでに getWriter()
メソッドが実行されていた場合IOException
- 入出力時に例外が発生した場合public PrintWriter getWriter() throws IOException
PrintWriter
オブジェクトを返します。getWriter
インタフェース内 javax.servlet.ServletResponse
getWriter
クラス内 javax.servlet.ServletResponseWrapper
PrintWriter
オブジェクトUnsupportedEncodingException
- setContentType メソッドで指定された文字エンコーディングがサポートされていない場合IllegalStateException
- このレスポンスですでに getOutputStream()
メソッドが実行されていた場合IOException
- 入出力時に例外が発生した場合public void setContentLength(int len)
setContentLength
インタフェース内 javax.servlet.ServletResponse
setContentLength
クラス内 javax.servlet.ServletResponseWrapper
len
- クライアントに送り返すメッセージボディの長さを指定する整数値。public void setContentType(String type)
setContentType
インタフェース内 javax.servlet.ServletResponse
setContentType
クラス内 javax.servlet.ServletResponseWrapper
type
- コンテントタイプを指定する Stringpublic void setBufferSize(int size)
setBufferSize
インタフェース内 javax.servlet.ServletResponse
setBufferSize
クラス内 javax.servlet.ServletResponseWrapper
size
- 適当なバッファサイズを指定する整数値IllegalStateException
- すでにコンテンツが出力された後でこのメソッドが実行された場合public int getBufferSize()
getBufferSize
インタフェース内 javax.servlet.ServletResponse
getBufferSize
クラス内 javax.servlet.ServletResponseWrapper
public void flushBuffer() throws IOException
flushBuffer
インタフェース内 javax.servlet.ServletResponse
flushBuffer
クラス内 javax.servlet.ServletResponseWrapper
IOException
- 入出力時に例外が発生した場合public void resetBuffer()
resetBuffer
インタフェース内 javax.servlet.ServletResponse
resetBuffer
クラス内 javax.servlet.ServletResponseWrapper
public boolean isCommitted()
isCommitted
インタフェース内 javax.servlet.ServletResponse
isCommitted
クラス内 javax.servlet.ServletResponseWrapper
public void reset()
reset
インタフェース内 javax.servlet.ServletResponse
reset
クラス内 javax.servlet.ServletResponseWrapper
public void setLocale(Locale loc)
setLocale
インタフェース内 javax.servlet.ServletResponse
setLocale
クラス内 javax.servlet.ServletResponseWrapper
loc
- レスポンスのロケールを指定する Locale
オブジェクトpublic Locale getLocale(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
Copyright © 2012 NTT DATA INTRAMART CORPORATION