|
intra-mart 6.1.14 | ||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object jp.co.intra_mart.common.aid.jsdk.javax.servlet.filter.AbstractHttpServletResponseEventListener
レスポンスの各メソッド呼び出しに対するイベントをフックするための抽象実装です。
このクラスは、フックしたレスポンスの適当なメソッドを実行するだけの単純実装です。 アプリケーションは、このクラスを継承して、 任意のメソッドのみをオーバーライドする事により 必要なイベントフックのみを実装する事ができます。
コンストラクタの概要 | |
protected |
AbstractHttpServletResponseEventListener()
新しいリスナを作成します。 |
メソッドの概要 | |
abstract void |
addCookie(HttpServletRequest request,
ExtendedHttpServletResponse response,
Cookie cookie)
指定されたCookieをレスポンスに追加します。 |
abstract void |
addDateHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。 |
abstract void |
addHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
String value)
指定された名称で指定された値を持つレスポンスヘッダを追加します。 |
abstract void |
addIntHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
int value)
指定された名称で指定された整数値を持つレスポンスヘッダを追加します。 |
abstract boolean |
containsHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name)
指定された名前を持つヘッダが既にセットされているかどうかを表す booleanを返します。 |
abstract String |
encodeRedirectURL(HttpServletRequest request,
ExtendedHttpServletResponse response,
String url)
#sendRedirect(String) メソッドの中で使えるように、 指定されたURLをエンコードします。
|
abstract String |
encodeURL(HttpServletRequest request,
ExtendedHttpServletResponse response,
String url)
指定されたURLがセッションIDを含むようにエンコードします。 |
abstract void |
flushBuffer(HttpServletRequest request,
ExtendedHttpServletResponse response)
バッファリングされているコンテンツを強制的にクライアントに出力します。 |
abstract int |
getBufferSize(HttpServletRequest request,
ExtendedHttpServletResponse response)
このレスポンスに設定されている実バッファサイズを返します。 |
abstract String |
getCharacterEncoding(HttpServletRequest request,
ExtendedHttpServletResponse response)
このレスポンスで送り返す MIME ボディに適用されている文字エンコーディング名を返します。 |
protected HttpServletResponseEventConfig |
getHttpServletResponseEventConfig()
このリスナに渡された設定オブジェクトを返します。 |
abstract Locale |
getLocale(HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスに設定されているロケールを返します。 |
abstract ServletOutputStream |
getOutputStream(HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスにバイナリデータを出力する際に使用する ServletOutputStream 型のオブジェクトを返します。
|
protected ServletContext |
getServletContext()
このリスナが実行されているサーブレットコンテキストを返します。 |
abstract PrintWriter |
getWriter(HttpServletRequest request,
ExtendedHttpServletResponse response)
文字データをクライアントに送り返すのに使用する PrintWriter オブジェクトを返します。
|
protected void |
handleInit()
このリスナを初期化します。 |
void |
init(HttpServletResponseEventConfig config)
このビルダを初期化します。 |
abstract boolean |
isCommitted(HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスがすでにコミットされたかどうかを示す boolean を返します。 |
abstract void |
reset(HttpServletRequest request,
ExtendedHttpServletResponse response)
バッファリングされているデータ、ステータスコードとヘッダフィールドの値を削除します。 |
abstract void |
resetBuffer(HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスのヘッダフィールドの値やステータスコードをそのままにしてバッファに溜められているコンテンツを消去します。 |
abstract void |
sendError(HttpServletRequest request,
ExtendedHttpServletResponse response,
int sc)
バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。 |
abstract void |
sendError(HttpServletRequest request,
ExtendedHttpServletResponse response,
int sc,
String msg)
バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。 |
abstract void |
sendRedirect(HttpServletRequest request,
ExtendedHttpServletResponse response,
String location)
指定されたリダイレクト先のURLを用いて、 クライアントに一時的なリダイレクトレスポンスを送信します。 |
abstract void |
setBufferSize(HttpServletRequest request,
ExtendedHttpServletResponse response,
int size)
適当なバッファサイズをレスポンスに含まれるメッセージボディのサイズに設定します。 |
abstract void |
setContentLength(HttpServletRequest request,
ExtendedHttpServletResponse response,
int len)
レスポンスのメッセージボディ部分の長さをセットします。 |
abstract void |
setContentType(HttpServletRequest request,
ExtendedHttpServletResponse response,
String type)
クライアントに送り返されるレスポンスのコンテントタイプをセットします。 |
abstract void |
setDateHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。 |
abstract void |
setHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
String value)
指定された名称で指定された値を持つレスポンスヘッダを設定します。 |
abstract void |
setIntHeader(HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
int value)
指定された名称で指定された整数値を持つレスポンスヘッダを設定します。 |
abstract void |
setLocale(HttpServletRequest request,
ExtendedHttpServletResponse response,
Locale loc)
レスポンスのロケールをセットしますが、このとき(Content-Type で指定する文字エンコーディングを含む)ヘッダも適当な値にセットします。 |
abstract void |
setStatus(HttpServletRequest request,
ExtendedHttpServletResponse response,
int sc)
このレスポンスのステータスコードを設定します。 |
クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
protected AbstractHttpServletResponseEventListener()
メソッドの詳細 |
public final void init(HttpServletResponseEventConfig config) throws HttpServletResponseEventListenerException
HttpServletResponseEventListener
内の init
config
- 初期化パラメータ
ServletException
- 初期化に失敗した場合
HttpServletResponseEventListenerException
- 初期化に失敗した場合protected void handleInit() throws HttpServletResponseEventListenerException
このメソッドは、#init(HttpServletResponseEventListenerConfig)
によって呼び出されます。
このメソッドは単にリターンするだけで、何もしません。
サブクラスが初期化処理を必要とする場合、
このメソッドをオーバーライドしてください。
ServletException
- 初期化に失敗した場合
HttpServletResponseEventListenerException
protected HttpServletResponseEventConfig getHttpServletResponseEventConfig()
protected ServletContext getServletContext()
public abstract String getCharacterEncoding(HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.getCharacterEncoding();
HttpServletResponseEventListener
内の getCharacterEncoding
request
- リクエストresponse
- イベントの発生したレスポンス
ServletResponse.getCharacterEncoding()
public abstract ServletOutputStream getOutputStream(HttpServletRequest request, ExtendedHttpServletResponse response) throws IOException
ServletOutputStream
型のオブジェクトを返します。
このメソッドは、単純に以下を実行します。
return response.getOutputStream();
HttpServletResponseEventListener
内の getOutputStream
request
- リクエストresponse
- イベントの発生したレスポンス
ServletOutputStream
IllegalStateException
- このレスポンスですでに #getWriter()
メソッドが実行されていた場合
IOException
- 入出力時に例外が発生した場合#getWriter(HTTPContext, ExtendedHttpServletResponse)
,
ServletResponse.getWriter()
,
ServletResponse.getOutputStream()
public abstract PrintWriter getWriter(HttpServletRequest request, ExtendedHttpServletResponse response) throws IOException
PrintWriter
オブジェクトを返します。
このメソッドは、単純に以下を実行します。
return response.getWriter();
HttpServletResponseEventListener
内の getWriter
request
- リクエストresponse
- イベントの発生したレスポンス
PrintWriter
オブジェクト
UnsupportedEncodingException
- setContentType メソッドで指定された文字エンコーディングがサポートされていない場合
IllegalStateException
- このレスポンスですでに #getOutputStream()
メソッドが実行されていた場合
IOException
- 入出力時に例外が発生した場合#getOutputStream(HTTPContext, ExtendedHttpServletResponse)
,
ServletResponse.getOutputStream()
,
ServletResponse.getWriter()
public abstract void setContentLength(HttpServletRequest request, ExtendedHttpServletResponse response, int len)
このメソッドは、単純に以下を実行します。
response.setContentLength(len);
HttpServletResponseEventListener
内の setContentLength
request
- リクエストresponse
- イベントの発生したレスポンスlen
- クライアントに送り返すメッセージボディの長さを指定する整数値。ServletResponse.setContentLength(int)
public abstract void setContentType(HttpServletRequest request, ExtendedHttpServletResponse response, String type)
このメソッドは、単純に以下を実行します。
response.setContentType(type);
HttpServletResponseEventListener
内の setContentType
request
- リクエストresponse
- イベントの発生したレスポンスtype
- コンテントタイプを指定する StringServletResponse.setContentType(String)
,
#getOutputStream(HTTPContext, ExtendedHttpServletResponse)
,
#getWriter(HTTPContext, ExtendedHttpServletResponse)
public abstract void setBufferSize(HttpServletRequest request, ExtendedHttpServletResponse response, int size)
このメソッドは、単純に以下を実行します。
response.setBufferSize(size);
HttpServletResponseEventListener
内の setBufferSize
request
- リクエストresponse
- イベントの発生したレスポンスsize
- 適当なバッファサイズを指定する整数値
IllegalStateException
- すでにコンテンツが出力された後でこのメソッドが実行された場合ServletResponse.setBufferSize(int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public abstract int getBufferSize(HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.getBufferSize();
HttpServletResponseEventListener
内の getBufferSize
request
- リクエストresponse
- イベントの発生したレスポンス
ServletResponse.getBufferSize()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public abstract void flushBuffer(HttpServletRequest request, ExtendedHttpServletResponse response) throws IOException
このメソッドは、単純に以下を実行します。
response.flushBuffer();
HttpServletResponseEventListener
内の flushBuffer
request
- リクエストresponse
- イベントの発生したレスポンス
IOException
- 入出力時に例外が発生した場合ServletResponse.flushBuffer()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public abstract void resetBuffer(HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
response.resetBuffer();
HttpServletResponseEventListener
内の resetBuffer
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.resetBuffer()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public abstract boolean isCommitted(HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.isCommitted();
HttpServletResponseEventListener
内の isCommitted
request
- リクエストresponse
- イベントの発生したレスポンス
ServletResponse.isCommitted()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public abstract void reset(HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
response.reset();
HttpServletResponseEventListener
内の reset
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.reset()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
public abstract void setLocale(HttpServletRequest request, ExtendedHttpServletResponse response, Locale loc)
このメソッドは、単純に以下を実行します。
response.setLocale(loc);
HttpServletResponseEventListener
内の setLocale
request
- リクエストresponse
- イベントの発生したレスポンスloc
- レスポンスのロケールを指定する Locale
オブジェクトServletResponse.setLocale(Locale)
,
#getLocale(HTTPContext, ExtendedHttpServletResponse)
public abstract Locale getLocale(HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.getLocale();
HttpServletResponseEventListener
内の getLocale
request
- リクエストresponse
- イベントの発生したレスポンス
ServletResponse.getLocale()
,
#setLocale(HTTPContext, ExtendedHttpServletResponse, java.util.Locale)
public abstract void addCookie(HttpServletRequest request, ExtendedHttpServletResponse response, Cookie cookie)
このメソッドは、単純に以下を実行します。
response.addCookie(cookie);
HttpServletResponseEventListener
内の addCookie
request
- リクエストresponse
- イベントの発生したレスポンスcookie
- クライアントに返すCookieHttpServletResponse.addCookie(Cookie)
public abstract boolean containsHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name)
このメソッドは、単純に以下を実行します。
return response.containsHeader(name);
HttpServletResponseEventListener
内の containsHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダ名
HttpServletResponse.containsHeader(String)
public abstract String encodeURL(HttpServletRequest request, ExtendedHttpServletResponse response, String url)
このメソッドは、単純に以下を実行します。
return response.encodeURL(url);
HttpServletResponseEventListener
内の encodeURL
request
- リクエストresponse
- イベントの発生したレスポンスurl
- エンコードするURL
HttpServletResponse.encodeURL(String)
public abstract String encodeRedirectURL(HttpServletRequest request, ExtendedHttpServletResponse response, String url)
#sendRedirect(String)
メソッドの中で使えるように、 指定されたURLをエンコードします。
このメソッドは、単純に以下を実行します。
return response.encodeRedirectURL(url);
HttpServletResponseEventListener
内の encodeRedirectURL
request
- リクエストresponse
- イベントの発生したレスポンスurl
- エンコードするURL
HttpServletResponse.encodeRedirectURL(String)
,
#sendRedirect(HTTPContext, ExtendedHttpServletResponse, String)
,
#encodeURL(HTTPContext, ExtendedHttpServletResponse, String)
public abstract void sendError(HttpServletRequest request, ExtendedHttpServletResponse response, int sc, String msg) throws IOException
このメソッドは、単純に以下を実行します。
response.sendError(sc, msg);
HttpServletResponseEventListener
内の sendError
request
- リクエストresponse
- イベントの発生したレスポンスsc
- エラーステータスコードmsg
- 説明文
IOException
- 入出力例外が発生した場合
IllegalStateException
- レスポンスが既にコミットされている場合HttpServletResponse.sendError(int, String)
public abstract void sendError(HttpServletRequest request, ExtendedHttpServletResponse response, int sc) throws IOException
このメソッドは、単純に以下を実行します。
response.sendError(sc);
HttpServletResponseEventListener
内の sendError
request
- リクエストresponse
- イベントの発生したレスポンスsc
- エラーステータスコード
IOException
- 入出力例外が発生した場合
IllegalStateException
- レスポンスが既にコミットされている場合HttpServletResponse.sendError(int)
public abstract void sendRedirect(HttpServletRequest request, ExtendedHttpServletResponse response, String location) throws IOException
このメソッドは、単純に以下を実行します。
response.sendRedirect(location);
HttpServletResponseEventListener
内の sendRedirect
request
- リクエストresponse
- イベントの発生したレスポンスlocation
- リダイレクト先のURL
IOException
- 入出力例外が発生した場合
IllegalStateException
- レスポンスが既にコミットされている場合HttpServletResponse.sendRedirect(String)
public abstract void setDateHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name, long date)
このメソッドは、単純に以下を実行します。
response.setDateHeader(name, date);
HttpServletResponseEventListener
内の setDateHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- 設定するヘッダの名称date
- 設定するヘッダの値HttpServletResponse.setDateHeader(String, long)
,
#containsHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String)
,
#addDateHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, long)
public abstract void addDateHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name, long date)
このメソッドは、単純に以下を実行します。
response.addDateHeader(name, date);
HttpServletResponseEventListener
内の addDateHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- 追加するヘッダの名称date
- 追加するヘッダの値HttpServletResponse.addDateHeader(String, long)
,
#setDateHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, long)
public abstract void setHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name, String value)
このメソッドは、単純に以下を実行します。
response.setHeader(name, value);
HttpServletResponseEventListener
内の setHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- ヘッダの値HttpServletResponse.setHeader(String, String)
,
#containsHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String)
,
#addHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, java.lang.String)
public abstract void addHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name, String value)
このメソッドは、単純に以下を実行します。
response.addHeader(name, value);
HttpServletResponseEventListener
内の addHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- 追加するヘッダの値HttpServletResponse.addHeader(String, String)
,
#setHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, java.lang.String)
public abstract void setIntHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name, int value)
このメソッドは、単純に以下を実行します。
response.setIntHeader(name, value);
HttpServletResponseEventListener
内の setIntHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- 割り当てられる整数値HttpServletResponse.setIntHeader(String, int)
,
#containsHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String)
,
#addIntHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, int)
public abstract void addIntHeader(HttpServletRequest request, ExtendedHttpServletResponse response, String name, int value)
このメソッドは、単純に以下を実行します。
response.addIntHeader(name, value);
HttpServletResponseEventListener
内の addIntHeader
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- 割り当てられる整数値HttpServletResponse.addIntHeader(String, int)
,
#setIntHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, int)
public abstract void setStatus(HttpServletRequest request, ExtendedHttpServletResponse response, int sc)
このメソッドは、単純に以下を実行します。
response.setStatus(sc);
HttpServletResponseEventListener
内の setStatus
request
- リクエストresponse
- イベントの発生したレスポンスsc
- ステータスコードHttpServletResponse.setStatus(int)
,
#sendError(HTTPContext, ExtendedHttpServletResponse, int, java.lang.String)
|
intra-mart 6.1.14 | ||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |