インタフェース RequestInfo
public interface RequestInfo
Web経由のリクエストの際の、HttpServletRequestから取得可能な情報を表す。
HttpServletRequestの一部メソッドを利用した場合、基盤の挙動を保証することが難しいため、
ラップするクラスを定義し、利用可能な情報のみ取得可能にしたもの。
Webからの呼び出しの際、CommandもしくはGroovyTemplateにて、
RequestContextのattributeから取得可能(attribute名は、WebRequestConstantsを参照のこと)。-
メソッドの概要
修飾子とタイプ メソッド 説明 java.lang.StringgetAuthType()java.lang.StringgetCharacterEncoding()intgetContentLength()java.lang.StringgetContentType()java.lang.StringgetContextPath()javax.servlet.http.Cookie[]getCookies()longgetDateHeader(java.lang.String name)java.lang.StringgetHeader(java.lang.String name)java.util.Enumeration<java.lang.String>getHeaderNames()java.util.Enumeration<java.lang.String>getHeaders(java.lang.String name)javax.servlet.ServletInputStreamgetInputStream()リクエストボディのInputStreamを取得します。intgetIntHeader(java.lang.String name)java.util.LocalegetLocale()現在のリクエストに最適の言語をLocaleの形式で取得します。java.util.Enumeration<java.util.Locale>getLocales()java.lang.StringgetMethod()java.lang.StringgetPathInfo()java.lang.StringgetProtocol()java.lang.StringgetQueryString()java.io.BufferedReadergetReader()リクエストボディのReaderを取得します。java.lang.StringgetRemoteAddr()java.lang.StringgetRemoteHost()intgetRemotePort()java.lang.StringgetRemoteUser()java.lang.StringgetRequestURI()java.lang.StringBuffergetRequestURL()java.lang.StringgetScheme()java.lang.StringgetServerName()intgetServerPort()java.lang.StringgetServletPath()java.security.PrincipalgetUserPrincipal()booleanisSecure()booleanisUserInRole(java.lang.String role)
-
メソッドの詳細
-
getInputStream
javax.servlet.ServletInputStream getInputStream() throws java.io.IOExceptionリクエストボディのInputStreamを取得します。 リクエストのヘッダーでcontent-typeが指定されていない場合、ボディは空として扱います。- 戻り値:
- 例外:
java.io.IOException- 関連項目:
ServletRequest.getInputStream()
-
getReader
java.io.BufferedReader getReader() throws java.io.IOExceptionリクエストボディのReaderを取得します。 リクエストのヘッダーでcontent-typeが指定されていない場合、ボディは空として扱います。- 戻り値:
- 例外:
java.io.IOException- 関連項目:
ServletRequest.getReader()
-
getCharacterEncoding
java.lang.String getCharacterEncoding()- 戻り値:
- 関連項目:
ServletRequest.getCharacterEncoding()
-
getContentLength
int getContentLength()- 戻り値:
- 関連項目:
ServletRequest.getContentLength()
-
getContentType
java.lang.String getContentType()- 戻り値:
- 関連項目:
ServletRequest.getContentType()
-
getLocale
java.util.Locale getLocale()現在のリクエストに最適の言語をLocaleの形式で取得します。- 戻り値:
- 関連項目:
ServletRequest.getLocale()
-
getProtocol
java.lang.String getProtocol()- 戻り値:
- 関連項目:
ServletRequest.getProtocol()
-
getRemoteAddr
java.lang.String getRemoteAddr()- 戻り値:
- 関連項目:
ServletRequest.getRemoteAddr()
-
getRemoteHost
java.lang.String getRemoteHost()- 戻り値:
- 関連項目:
ServletRequest.getRemoteHost()
-
getRemotePort
int getRemotePort()- 戻り値:
- 関連項目:
ServletRequest.getRemotePort()
-
getScheme
java.lang.String getScheme()- 戻り値:
- 関連項目:
ServletRequest.getScheme()
-
getServerName
java.lang.String getServerName()- 戻り値:
- 関連項目:
ServletRequest.getServerName()
-
getServerPort
int getServerPort()- 戻り値:
- 関連項目:
ServletRequest.getServerPort()
-
isSecure
boolean isSecure()- 戻り値:
- 関連項目:
ServletRequest.isSecure()
-
getAuthType
java.lang.String getAuthType()- 戻り値:
- 関連項目:
HttpServletRequest.getAuthType()
-
getContextPath
java.lang.String getContextPath()- 戻り値:
- 関連項目:
HttpServletRequest.getContextPath()
-
getCookies
javax.servlet.http.Cookie[] getCookies()- 戻り値:
- 関連項目:
HttpServletRequest.getCookies()
-
getDateHeader
long getDateHeader(java.lang.String name)- パラメータ:
name-- 戻り値:
- 関連項目:
HttpServletRequest.getDateHeader(String)
-
getHeader
java.lang.String getHeader(java.lang.String name)- パラメータ:
name-- 戻り値:
- 関連項目:
HttpServletRequest.getHeader(String)
-
getHeaderNames
java.util.Enumeration<java.lang.String> getHeaderNames()- 戻り値:
- 関連項目:
HttpServletRequest.getHeaderNames()
-
getHeaders
java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)- パラメータ:
name-- 戻り値:
- 関連項目:
HttpServletRequest.getHeaders(String)
-
getIntHeader
int getIntHeader(java.lang.String name)- パラメータ:
name-- 戻り値:
- 関連項目:
HttpServletRequest.getIntHeader(String)
-
getMethod
java.lang.String getMethod()- 戻り値:
- 関連項目:
HttpServletRequest.getMethod()
-
getPathInfo
java.lang.String getPathInfo()- 戻り値:
- 関連項目:
HttpServletRequest.getPathInfo()
-
getQueryString
java.lang.String getQueryString()- 戻り値:
- 関連項目:
HttpServletRequest.getQueryString()
-
getRemoteUser
java.lang.String getRemoteUser()- 戻り値:
- 関連項目:
HttpServletRequest.getRemoteUser()
-
getRequestURI
java.lang.String getRequestURI()- 戻り値:
- 関連項目:
HttpServletRequest.getRequestURI()
-
getRequestURL
java.lang.StringBuffer getRequestURL()- 戻り値:
- 関連項目:
HttpServletRequest.getRequestURL()
-
getServletPath
java.lang.String getServletPath()- 戻り値:
- 関連項目:
HttpServletRequest.getServletPath()
-
getUserPrincipal
java.security.Principal getUserPrincipal()- 戻り値:
- 関連項目:
HttpServletRequest.getUserPrincipal()
-
isUserInRole
boolean isUserInRole(java.lang.String role)- パラメータ:
role-- 戻り値:
- 関連項目:
HttpServletRequest.isUserInRole(String)
-
getLocales
java.util.Enumeration<java.util.Locale> getLocales()- 戻り値:
- 関連項目:
ServletRequest.getLocales()
-