jp.maru.liquid.plugin.http
インタフェース HttpRequest

既知の実装クラスの一覧:
HttpCoreRequest

public interface HttpRequest

Httpリクエストを表す

バージョン:
1.0
作成者:
Kohji Tsujita

メソッドの概要
 java.lang.Object getAttribute(java.lang.String name)
          指定された名前の属性値を返す
 Cookie[] getCookies()
          このリクエストと一緒に送られてきた全てのクッキー配列を返す
 java.lang.String getMethod()
          リクエストメソッドを返す
 java.lang.String getParameter(java.lang.String name)
          リクエストパラメータの値を返す。
 java.util.Enumeration<java.lang.String> getParameterNames()
          リクエストに含まれているパラメータ名を表すStringのEnumerationを返す。
 java.lang.String getQueryString()
          リクエストされたURLのパスの後ろに含まれているクエリ文字列を返す。
 java.lang.String getRequestURI()
          HTTPリクエストの最初の行にあるクエリ文字列までを返す。
 java.lang.String getServerName()
          リクエストから受け取ったサーバホスト名を返す
 HttpSession getSession()
          セッションを返す
 HttpSession getSession(boolean create)
          セッションを返す
 void removeAttribute(java.lang.String name)
          リクエストから属性を削除する
 void setAttribute(java.lang.String name, java.lang.Object o)
          リクエストに属性をセットする
 void setCharacterEncoding(java.lang.String encoding)
          リクエストで使われている文字エンコーディングを上書きする
 

メソッドの詳細

setCharacterEncoding

void setCharacterEncoding(java.lang.String encoding)
                          throws java.io.UnsupportedEncodingException
リクエストで使われている文字エンコーディングを上書きする

パラメータ:
encoding - 文字エンコーディング名
例外:
java.io.UnsupportedEncodingException

getAttribute

java.lang.Object getAttribute(java.lang.String name)
指定された名前の属性値を返す

パラメータ:
name - 属性名
戻り値:
オブジェクト

getCookies

Cookie[] getCookies()
このリクエストと一緒に送られてきた全てのクッキー配列を返す

戻り値:
クッキーの配列、クッキーがない場合はnull

getMethod

java.lang.String getMethod()
リクエストメソッドを返す

戻り値:
リクエストメソッド

getServerName

java.lang.String getServerName()
リクエストから受け取ったサーバホスト名を返す

戻り値:
サーバホスト名

getSession

HttpSession getSession()
セッションを返す

戻り値:
セッションオブジェクト

getSession

HttpSession getSession(boolean create)
セッションを返す

パラメータ:
create - 新たに生成する場合はtrue,falseの場合セッションが存在しないとnullを返す
戻り値:
セッションオブジェクト

getParameter

java.lang.String getParameter(java.lang.String name)
リクエストパラメータの値を返す。

パラメータ:
name - パラメータ名
戻り値:
パラメータ

getParameterNames

java.util.Enumeration<java.lang.String> getParameterNames()
リクエストに含まれているパラメータ名を表すStringのEnumerationを返す。 パラメータがない場合は空のEnumeration。

戻り値:
パラメータ名の入ったEnumeration

getQueryString

java.lang.String getQueryString()
リクエストされたURLのパスの後ろに含まれているクエリ文字列を返す。

戻り値:
クエリ文字列を表すString。

getRequestURI

java.lang.String getRequestURI()
HTTPリクエストの最初の行にあるクエリ文字列までを返す。

戻り値:
リクエストされたURI

removeAttribute

void removeAttribute(java.lang.String name)
リクエストから属性を削除する

パラメータ:
name - 属性名

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.Object o)
リクエストに属性をセットする

パラメータ:
name - 属性名
o - オブジェクト