public class SimpleHttpServletResponseEventListener extends AbstractHttpServletResponseEventListener
このクラスは、フックしたレスポンスの適当なメソッドを実行するだけの単純実装です。 アプリケーションは、このクラスを継承して、 任意のメソッドのみをオーバーライドする事により 必要なイベントフックのみを実装する事ができます。
修飾子 | コンストラクタと説明 |
---|---|
protected |
SimpleHttpServletResponseEventListener()
新しいリスナを作成します。
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
addCookie(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
javax.servlet.http.Cookie cookie)
指定されたCookieをレスポンスに追加します。
|
void |
addDateHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。
|
void |
addHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
String value)
指定された名称で指定された値を持つレスポンスヘッダを追加します。
|
void |
addIntHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
int value)
指定された名称で指定された整数値を持つレスポンスヘッダを追加します。
|
boolean |
containsHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name)
指定された名前を持つヘッダが既にセットされているかどうかを表す booleanを返します。
|
String |
encodeRedirectURL(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String url)
#sendRedirect(String) メソッドの中で使えるように、 指定されたURLをエンコードします。 |
String |
encodeURL(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String url)
指定されたURLがセッションIDを含むようにエンコードします。
|
void |
flushBuffer(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
バッファリングされているコンテンツを強制的にクライアントに出力します。
|
int |
getBufferSize(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
このレスポンスに設定されている実バッファサイズを返します。
|
String |
getCharacterEncoding(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
このレスポンスで送り返す MIME ボディに適用されている文字エンコーディング名を返します。
|
Locale |
getLocale(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスに設定されているロケールを返します。
|
javax.servlet.ServletOutputStream |
getOutputStream(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスにバイナリデータを出力する際に使用する
ServletOutputStream 型のオブジェクトを返します。 |
PrintWriter |
getWriter(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
文字データをクライアントに送り返すのに使用する
PrintWriter オブジェクトを返します。 |
boolean |
isCommitted(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスがすでにコミットされたかどうかを示す boolean を返します。
|
void |
reset(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
バッファリングされているデータ、ステータスコードとヘッダフィールドの値を削除します。
|
void |
resetBuffer(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response)
レスポンスのヘッダフィールドの値やステータスコードをそのままにしてバッファに溜められているコンテンツを消去します。
|
void |
sendError(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
int sc)
バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
|
void |
sendError(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
int sc,
String msg)
バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
|
void |
sendRedirect(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String location)
指定されたリダイレクト先のURLを用いて、 クライアントに一時的なリダイレクトレスポンスを送信します。
|
void |
setBufferSize(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
int size)
適当なバッファサイズをレスポンスに含まれるメッセージボディのサイズに設定します。
|
void |
setContentLength(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
int len)
レスポンスのメッセージボディ部分の長さをセットします。
|
void |
setContentType(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String type)
クライアントに送り返されるレスポンスのコンテントタイプをセットします。
|
void |
setDateHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。
|
void |
setHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
String value)
指定された名称で指定された値を持つレスポンスヘッダを設定します。
|
void |
setIntHeader(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
String name,
int value)
指定された名称で指定された整数値を持つレスポンスヘッダを設定します。
|
void |
setLocale(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
Locale loc)
レスポンスのロケールをセットしますが、このとき(Content-Type で指定する文字エンコーディングを含む)ヘッダも適当な値にセットします。
|
void |
setStatus(javax.servlet.http.HttpServletRequest request,
ExtendedHttpServletResponse response,
int sc)
このレスポンスのステータスコードを設定します。
|
getHttpServletResponseEventConfig, getServletContext, handleInit, init
protected SimpleHttpServletResponseEventListener()
public String getCharacterEncoding(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.getCharacterEncoding();
getCharacterEncoding
インタフェース内 HttpServletResponseEventListener
getCharacterEncoding
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.getCharacterEncoding()
public javax.servlet.ServletOutputStream getOutputStream(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response) throws IOException
ServletOutputStream
型のオブジェクトを返します。
このメソッドは、単純に以下を実行します。
return response.getOutputStream();
getOutputStream
インタフェース内 HttpServletResponseEventListener
getOutputStream
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletOutputStream
IllegalStateException
- このレスポンスですでに #getWriter()
メソッドが実行されていた場合IOException
- 入出力時に例外が発生した場合#getWriter(HTTPContext, ExtendedHttpServletResponse)
,
ServletResponse.getWriter()
,
ServletResponse.getOutputStream()
public PrintWriter getWriter(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response) throws IOException
PrintWriter
オブジェクトを返します。
このメソッドは、単純に以下を実行します。
return response.getWriter();
getWriter
インタフェース内 HttpServletResponseEventListener
getWriter
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスPrintWriter
オブジェクトUnsupportedEncodingException
- setContentType メソッドで指定された文字エンコーディングがサポートされていない場合IllegalStateException
- このレスポンスですでに #getOutputStream()
メソッドが実行されていた場合IOException
- 入出力時に例外が発生した場合#getOutputStream(HTTPContext, ExtendedHttpServletResponse)
,
ServletResponse.getOutputStream()
,
ServletResponse.getWriter()
public void setContentLength(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, int len)
このメソッドは、単純に以下を実行します。
response.setContentLength(len);
setContentLength
インタフェース内 HttpServletResponseEventListener
setContentLength
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスlen
- クライアントに送り返すメッセージボディの長さを指定する整数値。ServletResponse.setContentLength(int)
public void setContentType(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String type)
このメソッドは、単純に以下を実行します。
response.setContentType(type);
setContentType
インタフェース内 HttpServletResponseEventListener
setContentType
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスtype
- コンテントタイプを指定する StringServletResponse.setContentType(String)
,
#getOutputStream(HTTPContext, ExtendedHttpServletResponse)
,
#getWriter(HTTPContext, ExtendedHttpServletResponse)
public void setBufferSize(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, int size)
このメソッドは、単純に以下を実行します。
response.setBufferSize(size);
setBufferSize
インタフェース内 HttpServletResponseEventListener
setBufferSize
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスsize
- 適当なバッファサイズを指定する整数値IllegalStateException
- すでにコンテンツが出力された後でこのメソッドが実行された場合ServletResponse.setBufferSize(int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public int getBufferSize(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.getBufferSize();
getBufferSize
インタフェース内 HttpServletResponseEventListener
getBufferSize
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.getBufferSize()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public void flushBuffer(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response) throws IOException
このメソッドは、単純に以下を実行します。
response.flushBuffer();
flushBuffer
インタフェース内 HttpServletResponseEventListener
flushBuffer
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスIOException
- 入出力時に例外が発生した場合ServletResponse.flushBuffer()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public void resetBuffer(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
response.resetBuffer();
resetBuffer
インタフェース内 HttpServletResponseEventListener
resetBuffer
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.resetBuffer()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public boolean isCommitted(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.isCommitted();
isCommitted
インタフェース内 HttpServletResponseEventListener
isCommitted
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.isCommitted()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#reset(HTTPContext, ExtendedHttpServletResponse)
public void reset(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
response.reset();
reset
インタフェース内 HttpServletResponseEventListener
reset
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.reset()
,
#setBufferSize(HTTPContext, ExtendedHttpServletResponse, int)
,
#getBufferSize(HTTPContext, ExtendedHttpServletResponse)
,
#flushBuffer(HTTPContext, ExtendedHttpServletResponse)
,
#isCommitted(HTTPContext, ExtendedHttpServletResponse)
public void setLocale(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, Locale loc)
このメソッドは、単純に以下を実行します。
response.setLocale(loc);
setLocale
インタフェース内 HttpServletResponseEventListener
setLocale
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスloc
- レスポンスのロケールを指定する Locale
オブジェクトServletResponse.setLocale(Locale)
,
#getLocale(HTTPContext, ExtendedHttpServletResponse)
public Locale getLocale(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response)
このメソッドは、単純に以下を実行します。
return response.getLocale();
getLocale
インタフェース内 HttpServletResponseEventListener
getLocale
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスServletResponse.getLocale()
,
#setLocale(HTTPContext, ExtendedHttpServletResponse, java.util.Locale)
public void addCookie(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, javax.servlet.http.Cookie cookie)
このメソッドは、単純に以下を実行します。
response.addCookie(cookie);
addCookie
インタフェース内 HttpServletResponseEventListener
addCookie
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスcookie
- クライアントに返すCookieHttpServletResponse.addCookie(Cookie)
public boolean containsHeader(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name)
このメソッドは、単純に以下を実行します。
return response.containsHeader(name);
containsHeader
インタフェース内 HttpServletResponseEventListener
containsHeader
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダ名HttpServletResponse.containsHeader(String)
public String encodeURL(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String url)
このメソッドは、単純に以下を実行します。
return response.encodeURL(url);
encodeURL
インタフェース内 HttpServletResponseEventListener
encodeURL
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスurl
- エンコードするURLHttpServletResponse.encodeURL(String)
public String encodeRedirectURL(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String url)
#sendRedirect(String)
メソッドの中で使えるように、 指定されたURLをエンコードします。
このメソッドは、単純に以下を実行します。
return response.encodeRedirectURL(url);
encodeRedirectURL
インタフェース内 HttpServletResponseEventListener
encodeRedirectURL
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスurl
- エンコードするURLHttpServletResponse.encodeRedirectURL(String)
,
#sendRedirect(HTTPContext, ExtendedHttpServletResponse, String)
,
#encodeURL(HTTPContext, ExtendedHttpServletResponse, String)
public void sendError(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, int sc, String msg) throws IOException
このメソッドは、単純に以下を実行します。
response.sendError(sc, msg);
sendError
インタフェース内 HttpServletResponseEventListener
sendError
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスsc
- エラーステータスコードmsg
- 説明文IOException
- 入出力例外が発生した場合IllegalStateException
- レスポンスが既にコミットされている場合HttpServletResponse.sendError(int, String)
public void sendError(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, int sc) throws IOException
このメソッドは、単純に以下を実行します。
response.sendError(sc);
sendError
インタフェース内 HttpServletResponseEventListener
sendError
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスsc
- エラーステータスコードIOException
- 入出力例外が発生した場合IllegalStateException
- レスポンスが既にコミットされている場合HttpServletResponse.sendError(int)
public void sendRedirect(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String location) throws IOException
このメソッドは、単純に以下を実行します。
response.sendRedirect(location);
sendRedirect
インタフェース内 HttpServletResponseEventListener
sendRedirect
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスlocation
- リダイレクト先のURLIOException
- 入出力例外が発生した場合IllegalStateException
- レスポンスが既にコミットされている場合HttpServletResponse.sendRedirect(String)
public void setDateHeader(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name, long date)
このメソッドは、単純に以下を実行します。
response.setDateHeader(name, date);
setDateHeader
インタフェース内 HttpServletResponseEventListener
setDateHeader
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスname
- 設定するヘッダの名称date
- 設定するヘッダの値HttpServletResponse.setDateHeader(String, long)
,
#containsHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String)
,
#addDateHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, long)
public void addDateHeader(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name, long date)
このメソッドは、単純に以下を実行します。
response.addDateHeader(name, date);
addDateHeader
インタフェース内 HttpServletResponseEventListener
addDateHeader
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスname
- 追加するヘッダの名称date
- 追加するヘッダの値HttpServletResponse.addDateHeader(String, long)
,
#setDateHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, long)
public void setHeader(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name, String value)
このメソッドは、単純に以下を実行します。
response.setHeader(name, value);
setHeader
インタフェース内 HttpServletResponseEventListener
setHeader
クラス内 AbstractHttpServletResponseEventListener
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(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name, String value)
このメソッドは、単純に以下を実行します。
response.addHeader(name, value);
addHeader
インタフェース内 HttpServletResponseEventListener
addHeader
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- 追加するヘッダの値HttpServletResponse.addHeader(String, String)
,
#setHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, java.lang.String)
public void setIntHeader(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name, int value)
このメソッドは、単純に以下を実行します。
response.setIntHeader(name, value);
setIntHeader
インタフェース内 HttpServletResponseEventListener
setIntHeader
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- 割り当てられる整数値HttpServletResponse.setIntHeader(String, int)
,
#containsHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String)
,
#addIntHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, int)
public void addIntHeader(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, String name, int value)
このメソッドは、単純に以下を実行します。
response.addIntHeader(name, value);
addIntHeader
インタフェース内 HttpServletResponseEventListener
addIntHeader
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスname
- ヘッダの名称value
- 割り当てられる整数値HttpServletResponse.addIntHeader(String, int)
,
#setIntHeader(HTTPContext, ExtendedHttpServletResponse, java.lang.String, int)
public void setStatus(javax.servlet.http.HttpServletRequest request, ExtendedHttpServletResponse response, int sc)
このメソッドは、単純に以下を実行します。
response.setStatus(sc);
setStatus
インタフェース内 HttpServletResponseEventListener
setStatus
クラス内 AbstractHttpServletResponseEventListener
request
- リクエストresponse
- イベントの発生したレスポンスsc
- ステータスコードHttpServletResponse.setStatus(int)
,
#sendError(HTTPContext, ExtendedHttpServletResponse, int, java.lang.String)
Copyright © 2012 NTT DATA INTRAMART CORPORATION