Package org.iplass.mtp.web.actionmapping
Interface RequestInfo
public interface RequestInfo
Represents available methods of HttpServletRequest.
When using some methods of HttpServletRequest,
it is difficult to guarantee iPLAss's behavior,
so the interface is defined and only the methods that can be used are defined.
When invoke from the web, in Command or GroovyTemplate,
It can be get from the attribute of
RequestContext.
see WebRequestConstants for attribute name.-
Method Summary
Modifier and Type Method Description 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()Get InputStream of request body.intgetIntHeader(java.lang.String name)java.util.LocalegetLocale()Get the appropriate locale of language for the current request.java.util.Enumeration<java.util.Locale>getLocales()java.lang.StringgetMethod()java.lang.StringgetPathInfo()java.lang.StringgetProtocol()java.lang.StringgetQueryString()java.io.BufferedReadergetReader()Get Reader of request body.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)
-
Method Details
-
getInputStream
javax.servlet.ServletInputStream getInputStream() throws java.io.IOExceptionGet InputStream of request body. If content-type is not specified in the request header, the body is treated as empty.- Returns:
- Throws:
java.io.IOException- See Also:
ServletRequest.getInputStream()
-
getReader
java.io.BufferedReader getReader() throws java.io.IOExceptionGet Reader of request body. If content-type is not specified in the request header, the body is treated as empty.- Returns:
- Throws:
java.io.IOException- See Also:
ServletRequest.getReader()
-
getCharacterEncoding
java.lang.String getCharacterEncoding()- Returns:
- See Also:
ServletRequest.getCharacterEncoding()
-
getContentLength
int getContentLength()- Returns:
- See Also:
ServletRequest.getContentLength()
-
getContentType
java.lang.String getContentType()- Returns:
- See Also:
ServletRequest.getContentType()
-
getLocale
java.util.Locale getLocale()Get the appropriate locale of language for the current request.- Returns:
- See Also:
ServletRequest.getLocale()
-
getProtocol
java.lang.String getProtocol()- Returns:
- See Also:
ServletRequest.getProtocol()
-
getRemoteAddr
java.lang.String getRemoteAddr()- Returns:
- See Also:
ServletRequest.getRemoteAddr()
-
getRemoteHost
java.lang.String getRemoteHost()- Returns:
- See Also:
ServletRequest.getRemoteHost()
-
getRemotePort
int getRemotePort()- Returns:
- See Also:
ServletRequest.getRemotePort()
-
getScheme
java.lang.String getScheme()- Returns:
- See Also:
ServletRequest.getScheme()
-
getServerName
java.lang.String getServerName()- Returns:
- See Also:
ServletRequest.getServerName()
-
getServerPort
int getServerPort()- Returns:
- See Also:
ServletRequest.getServerPort()
-
isSecure
boolean isSecure()- Returns:
- See Also:
ServletRequest.isSecure()
-
getAuthType
java.lang.String getAuthType()- Returns:
- See Also:
HttpServletRequest.getAuthType()
-
getContextPath
java.lang.String getContextPath()- Returns:
- See Also:
HttpServletRequest.getContextPath()
-
getCookies
javax.servlet.http.Cookie[] getCookies()- Returns:
- See Also:
HttpServletRequest.getCookies()
-
getDateHeader
long getDateHeader(java.lang.String name)- Parameters:
name-- Returns:
- See Also:
HttpServletRequest.getDateHeader(String)
-
getHeader
java.lang.String getHeader(java.lang.String name)- Parameters:
name-- Returns:
- See Also:
HttpServletRequest.getHeader(String)
-
getHeaderNames
java.util.Enumeration<java.lang.String> getHeaderNames()- Returns:
- See Also:
HttpServletRequest.getHeaderNames()
-
getHeaders
java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)- Parameters:
name-- Returns:
- See Also:
HttpServletRequest.getHeaders(String)
-
getIntHeader
int getIntHeader(java.lang.String name)- Parameters:
name-- Returns:
- See Also:
HttpServletRequest.getIntHeader(String)
-
getMethod
java.lang.String getMethod()- Returns:
- See Also:
HttpServletRequest.getMethod()
-
getPathInfo
java.lang.String getPathInfo()- Returns:
- See Also:
HttpServletRequest.getPathInfo()
-
getQueryString
java.lang.String getQueryString()- Returns:
- See Also:
HttpServletRequest.getQueryString()
-
getRemoteUser
java.lang.String getRemoteUser()- Returns:
- See Also:
HttpServletRequest.getRemoteUser()
-
getRequestURI
java.lang.String getRequestURI()- Returns:
- See Also:
HttpServletRequest.getRequestURI()
-
getRequestURL
java.lang.StringBuffer getRequestURL()- Returns:
- See Also:
HttpServletRequest.getRequestURL()
-
getServletPath
java.lang.String getServletPath()- Returns:
- See Also:
HttpServletRequest.getServletPath()
-
getUserPrincipal
java.security.Principal getUserPrincipal()- Returns:
- See Also:
HttpServletRequest.getUserPrincipal()
-
isUserInRole
boolean isUserInRole(java.lang.String role)- Parameters:
role-- Returns:
- See Also:
HttpServletRequest.isUserInRole(String)
-
getLocales
java.util.Enumeration<java.util.Locale> getLocales()- Returns:
- See Also:
ServletRequest.getLocales()
-