FlatServe
0.4

com.small_it_office.flatserve.core.response
クラス Response

java.lang.Object
  上位を拡張 com.small_it_office.flatserve.core.response.Response
直系の既知のサブクラス:
ByteArrayResponse, ForwardResponse, TextResponse

public abstract class Response
extends java.lang.Object

HTTPの応答を表すクラスの基底クラスです。 サービスメソッドが、このクラスのサブクラスのオブジェクトを戻り値として返すと、 sendResponse()メソッドがHTTP応答を生成します。 サブクラスでは、getContentType()を実装してHTTP応答のcontent-typeヘッダを決定し、 writeResponse()メソッドでレスポンス送信処理の実装を行います。


コンストラクタの概要
Response()
           
 
メソッドの概要
protected abstract  java.lang.String getContentType()
          HTTP応答で送信するcontent-typeヘッダの値を返します。
 java.lang.String getHeader(java.lang.String name)
          応答に追加されるHTTPヘッダの値を取得します。
 java.util.Map<java.lang.String,java.lang.String> getHeaders()
          応答に追加されるHTTPヘッダを、保持しているものについて全て取得します。
 int getStatusCode()
          レスポンスで返却するHTTPステータスコードを取得します。
 void sendResponse()
          HTTP応答を送信します。
 void setHeader(java.lang.String name, java.lang.String value)
          応答に追加するHTTPヘッダを設定します。
 void setStatusCode(int statusCode)
          レスポンスで返却するHTTPステータスコードを設定します。
protected abstract  void writeResponse()
          HTTP応答を書き込みます。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Response

public Response()
メソッドの詳細

getContentType

protected abstract java.lang.String getContentType()
HTTP応答で送信するcontent-typeヘッダの値を返します。

戻り値:
content-typeヘッダの値

writeResponse

protected abstract void writeResponse()
                               throws java.io.IOException
HTTP応答を書き込みます。 このメソッドはアプリケーションから呼び出すことはありません。

応答を書き込む前後に何らかの処理が必要であれば、それもこのメソッドで行います。 ただし、setHeader(String, String)メソッドで設定したHTTPヘッダは sendResponse()メソッド内で行われるので、実装する必要はありません。 また、HttpServletResponse#flushBuffer()についても同様にこのメソッド内で行う必要はありません。

例外:
java.io.IOException - 応答の書き込み時にIOエラーが発生した場合

getStatusCode

public int getStatusCode()
レスポンスで返却するHTTPステータスコードを取得します。

戻り値:
レスポンスで返却するHTTPステータスコード。明示的に設定されていない場合は0。

setStatusCode

public void setStatusCode(int statusCode)
レスポンスで返却するHTTPステータスコードを設定します。

パラメータ:
statusCode - レスポンスで返却するHTTPステータスコード。

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
応答に追加するHTTPヘッダを設定します。

パラメータ:
name - HTTPヘッダ名
value - HTTPヘッダの値

getHeader

public java.lang.String getHeader(java.lang.String name)
応答に追加されるHTTPヘッダの値を取得します。

パラメータ:
name - HTTPヘッダ名
戻り値:
value

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()
応答に追加されるHTTPヘッダを、保持しているものについて全て取得します。

戻り値:
応答に追加するHTTPヘッダを保持するMap

sendResponse

public void sendResponse()
                  throws java.io.IOException
HTTP応答を送信します。 このメソッドはFlatServeが内部で実行します。アプリケーションからは実行できません。

例外:
java.io.IOException - 応答の書き込み時にIOエラーが発生した場合

FlatServe
0.4