|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.struts2.portlet.servlet.PortletServletRequest
public class PortletServletRequest
Wrapper object exposing a PortletRequest
as a
HttpServletRequest
instance. Clients accessing this request object
will in fact operate on the PortletRequest
object wrapped by this
request object.
Field Summary |
---|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
PortletServletRequest(javax.portlet.PortletRequest portletRequest,
javax.portlet.PortletContext portletContext)
|
|
PortletServletRequest(javax.portlet.PortletRequest portletRequest,
javax.portlet.PortletContext portletContext,
java.util.Map<java.lang.String,java.lang.String[]> extraParams)
|
Method Summary | |
---|---|
java.lang.Object |
getAttribute(java.lang.String name)
Gets an attribute value on the PortletRequest . |
java.util.Enumeration |
getAttributeNames()
|
java.lang.String |
getAuthType()
|
java.lang.String |
getCharacterEncoding()
Can only be invoked in the event phase. |
int |
getContentLength()
Can only be invoked in the event phase. |
java.lang.String |
getContentType()
Can only be invoked in the event phase. |
java.lang.String |
getContextPath()
|
javax.servlet.http.Cookie[] |
getCookies()
Not allowed in a portlet. |
long |
getDateHeader(java.lang.String name)
Not allowed in a portlet. |
java.lang.String |
getHeader(java.lang.String name)
Gets a property from the PortletRequest . |
java.util.Enumeration |
getHeaderNames()
Gets the property names from the PortletRequest . |
java.util.Enumeration |
getHeaders(java.lang.String name)
Gets the values for the specified property from the PortletRequest . |
javax.servlet.ServletInputStream |
getInputStream()
Can only be invoked in the event phase. |
int |
getIntHeader(java.lang.String name)
Not allowed in a portlet. |
java.lang.String |
getLocalAddr()
Not allowed in a portlet. |
java.util.Locale |
getLocale()
|
java.util.Enumeration |
getLocales()
|
java.lang.String |
getLocalName()
Not allowed in a portlet. |
int |
getLocalPort()
Not allowed in a portlet. |
java.lang.String |
getMethod()
|
java.lang.String |
getParameter(java.lang.String name)
|
java.util.Map |
getParameterMap()
|
java.util.Enumeration |
getParameterNames()
|
java.lang.String[] |
getParameterValues(java.lang.String name)
|
java.lang.String |
getPathInfo()
|
java.lang.String |
getPathTranslated()
|
javax.portlet.PortletRequest |
getPortletRequest()
Get the wrapped PortletRequest instance. |
java.lang.String |
getProtocol()
Not allowed in a portlet. |
java.lang.String |
getQueryString()
|
java.io.BufferedReader |
getReader()
Can only be invoked in the event phase. |
java.lang.String |
getRealPath(java.lang.String path)
|
java.lang.String |
getRemoteAddr()
Not allowed in a portlet. |
java.lang.String |
getRemoteHost()
Not allowed in a portlet. |
int |
getRemotePort()
Not allowed in a portlet. |
java.lang.String |
getRemoteUser()
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String path)
Get the PortletRequestDispatcher as a
PortletServletRequestDispatcher instance. |
java.lang.String |
getRequestedSessionId()
|
java.lang.String |
getRequestURI()
Not allowed in a portlet. |
java.lang.StringBuffer |
getRequestURL()
Not allowed in a portlet. |
java.lang.String |
getScheme()
|
java.lang.String |
getServerName()
|
int |
getServerPort()
Not allowed in a portlet. |
java.lang.String |
getServletPath()
A PortletRequest has no servlet path. |
javax.servlet.http.HttpSession |
getSession()
Get the PortletSession as a PortletHttpSession instance. |
javax.servlet.http.HttpSession |
getSession(boolean create)
Get the PortletSession as a PortletHttpSession instance. |
java.security.Principal |
getUserPrincipal()
|
boolean |
isRequestedSessionIdFromCookie()
Not allowed in a portlet. |
boolean |
isRequestedSessionIdFromUrl()
Not allowed in a portlet. |
boolean |
isRequestedSessionIdFromURL()
Not allowed in a portlet. |
boolean |
isRequestedSessionIdValid()
|
boolean |
isSecure()
|
boolean |
isUserInRole(java.lang.String role)
|
void |
removeAttribute(java.lang.String name)
|
void |
setAttribute(java.lang.String name,
java.lang.Object o)
|
void |
setCharacterEncoding(java.lang.String env)
Can only be invoked in the event phase. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PortletServletRequest(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletContext portletContext)
public PortletServletRequest(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletContext portletContext, java.util.Map<java.lang.String,java.lang.String[]> extraParams)
Method Detail |
---|
public java.lang.String getAuthType()
getAuthType
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getContextPath()
getContextPath
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.Cookie[] getCookies()
getCookies
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public long getDateHeader(java.lang.String name)
getDateHeader
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.lang.String getHeader(java.lang.String name)
PortletRequest
. Note that a
PortletRequest
is not guaranteed to map properties to headers.
getHeader
in interface javax.servlet.http.HttpServletRequest
PortletRequest.getProperty(String)
,
HttpServletRequest.getHeader(java.lang.String)
public java.util.Enumeration getHeaderNames()
PortletRequest
. Note that a
PortletRequest
is not guaranteed to map properties to headers.
getHeaderNames
in interface javax.servlet.http.HttpServletRequest
PortletRequest.getPropertyNames()
,
HttpServletRequest.getHeaderNames()
public java.util.Enumeration getHeaders(java.lang.String name)
PortletRequest
. Note that a PortletRequest
is not
guaranteed to map properties to headers.
getHeaders
in interface javax.servlet.http.HttpServletRequest
PortletRequest.getProperties(String)
,
HttpServletRequest.getHeaders(String)
public int getIntHeader(java.lang.String name)
getIntHeader
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.lang.String getMethod()
getMethod
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getPathInfo()
getPathInfo
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getPathTranslated()
getPathTranslated
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getQueryString()
getQueryString
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getRemoteUser()
getRemoteUser
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getRequestURI()
getRequestURI
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.lang.StringBuffer getRequestURL()
getRequestURL
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.lang.String getRequestedSessionId()
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
public java.lang.String getServletPath()
PortletRequest
has no servlet path. But for compatibility with
Struts 2 components and interceptors, the action parameter on the request
is mapped to the servlet path.
getServletPath
in interface javax.servlet.http.HttpServletRequest
HttpServletRequest.getServletPath()
public javax.servlet.http.HttpSession getSession()
PortletSession
as a PortletHttpSession
instance.
getSession
in interface javax.servlet.http.HttpServletRequest
HttpServletRequest.getSession()
public javax.servlet.http.HttpSession getSession(boolean create)
PortletSession
as a PortletHttpSession
instance.
getSession
in interface javax.servlet.http.HttpServletRequest
HttpServletRequest.getSession(boolean)
public java.security.Principal getUserPrincipal()
getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface javax.servlet.http.HttpServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
public boolean isUserInRole(java.lang.String role)
isUserInRole
in interface javax.servlet.http.HttpServletRequest
public java.lang.Object getAttribute(java.lang.String name)
PortletRequest
. If the attribute
name is javax.servlet.include.servlet_path, it returns the
same as getServletPath()
getAttribute
in interface javax.servlet.ServletRequest
ServletRequest.getAttribute(java.lang.String)
public java.util.Enumeration getAttributeNames()
getAttributeNames
in interface javax.servlet.ServletRequest
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- If the portlet is not in the event phase.ServletRequest.getCharacterEncoding()
public int getContentLength()
getContentLength
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- If the portlet is not in the event phase.ServletRequest.getContentLength()
public java.lang.String getContentType()
getContentType
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- If the portlet is not in the event phase.ServletRequest.getContentType()
public javax.servlet.ServletInputStream getInputStream() throws java.io.IOException
InputStream
as a
PortletServletInputStream
.
getInputStream
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- If the portlet is not in the event phase.
java.io.IOException
ServletRequest.getInputStream()
public java.lang.String getLocalAddr()
getLocalAddr
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.lang.String getLocalName()
getLocalName
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public int getLocalPort()
getLocalPort
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.util.Locale getLocale()
getLocale
in interface javax.servlet.ServletRequest
public java.util.Enumeration getLocales()
getLocales
in interface javax.servlet.ServletRequest
public java.lang.String getParameter(java.lang.String name)
getParameter
in interface javax.servlet.ServletRequest
public java.util.Map getParameterMap()
getParameterMap
in interface javax.servlet.ServletRequest
public java.util.Enumeration getParameterNames()
getParameterNames
in interface javax.servlet.ServletRequest
public java.lang.String[] getParameterValues(java.lang.String name)
getParameterValues
in interface javax.servlet.ServletRequest
public java.lang.String getProtocol()
getProtocol
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.io.BufferedReader getReader() throws java.io.IOException
getReader
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- If the portlet is not in the event phase.
java.io.IOException
ServletRequest.getReader()
public java.lang.String getRealPath(java.lang.String path)
getRealPath
in interface javax.servlet.ServletRequest
public java.lang.String getRemoteAddr()
getRemoteAddr
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public java.lang.String getRemoteHost()
getRemoteHost
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public int getRemotePort()
getRemotePort
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
PortletRequestDispatcher
as a
PortletServletRequestDispatcher
instance.
getRequestDispatcher
in interface javax.servlet.ServletRequest
ServletRequest.getRequestDispatcher(java.lang.String)
public java.lang.String getScheme()
getScheme
in interface javax.servlet.ServletRequest
public java.lang.String getServerName()
getServerName
in interface javax.servlet.ServletRequest
public int getServerPort()
getServerPort
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- Not allowed in a portlet.public boolean isSecure()
isSecure
in interface javax.servlet.ServletRequest
public void removeAttribute(java.lang.String name)
removeAttribute
in interface javax.servlet.ServletRequest
public void setAttribute(java.lang.String name, java.lang.Object o)
setAttribute
in interface javax.servlet.ServletRequest
public void setCharacterEncoding(java.lang.String env) throws java.io.UnsupportedEncodingException
setCharacterEncoding
in interface javax.servlet.ServletRequest
java.lang.IllegalStateException
- If the portlet is not in the event phase.
java.io.UnsupportedEncodingException
ServletRequest.setCharacterEncoding(String)
public javax.portlet.PortletRequest getPortletRequest()
PortletRequest
instance.
PortletRequest
instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |