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