Java Doc for PortletServletRequest.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » portlet » servlet » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Framework » struts 2.0.11 » org.apache.struts2.portlet.servlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.struts2.portlet.servlet.PortletServletRequest

PortletServletRequest
public class PortletServletRequest implements HttpServletRequest,PortletActionConstants(Code)
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.



Constructor Summary
public  PortletServletRequest(PortletRequest portletRequest, PortletContext portletContext)
    

Method Summary
public  ObjectgetAttribute(String name)
     Gets an attribute value on the PortletRequest .
public  EnumerationgetAttributeNames()
    
public  StringgetAuthType()
    
public  StringgetCharacterEncoding()
     Can only be invoked in the event phase.
public  intgetContentLength()
     Can only be invoked in the event phase.
public  StringgetContentType()
     Can only be invoked in the event phase.
public  StringgetContextPath()
    
public  Cookie[]getCookies()
     Not allowed in a portlet.
public  longgetDateHeader(String name)
     Not allowed in a portlet.
public  StringgetHeader(String name)
     Gets a property from the PortletRequest .
public  EnumerationgetHeaderNames()
     Gets the property names from the PortletRequest .
public  EnumerationgetHeaders(String name)
     Gets the values for the specified property from the PortletRequest .
public  ServletInputStreamgetInputStream()
     Can only be invoked in the event phase.
public  intgetIntHeader(String name)
     Not allowed in a portlet.
public  StringgetLocalAddr()
     Not allowed in a portlet.
public  StringgetLocalName()
     Not allowed in a portlet.
public  intgetLocalPort()
     Not allowed in a portlet.
public  LocalegetLocale()
    
public  EnumerationgetLocales()
    
public  StringgetMethod()
    
public  StringgetParameter(String name)
    
public  MapgetParameterMap()
    
public  EnumerationgetParameterNames()
    
public  String[]getParameterValues(String name)
    
public  StringgetPathInfo()
    
public  StringgetPathTranslated()
    
public  PortletRequestgetPortletRequest()
     Get the wrapped PortletRequest instance.
public  StringgetProtocol()
     Not allowed in a portlet.
public  StringgetQueryString()
    
public  BufferedReadergetReader()
     Can only be invoked in the event phase.
public  StringgetRealPath(String path)
    
public  StringgetRemoteAddr()
     Not allowed in a portlet.
public  StringgetRemoteHost()
     Not allowed in a portlet.
public  intgetRemotePort()
     Not allowed in a portlet.
public  StringgetRemoteUser()
    
public  RequestDispatchergetRequestDispatcher(String path)
     Get the PortletRequestDispatcher as a PortletServletRequestDispatcher instance.
public  StringgetRequestURI()
     Not allowed in a portlet.
public  StringBuffergetRequestURL()
     Not allowed in a portlet.
public  StringgetRequestedSessionId()
    
public  StringgetScheme()
    
public  StringgetServerName()
    
public  intgetServerPort()
     Not allowed in a portlet.
public  StringgetServletPath()
     A PortletRequest has no servlet path.
public  HttpSessiongetSession()
     Get the PortletSession as a PortletHttpSession instance.
public  HttpSessiongetSession(boolean create)
     Get the PortletSession as a PortletHttpSession instance.
public  PrincipalgetUserPrincipal()
    
public  booleanisRequestedSessionIdFromCookie()
     Not allowed in a portlet.
public  booleanisRequestedSessionIdFromURL()
     Not allowed in a portlet.
public  booleanisRequestedSessionIdFromUrl()
     Not allowed in a portlet.
public  booleanisRequestedSessionIdValid()
    
public  booleanisSecure()
    
public  booleanisUserInRole(String role)
    
public  voidremoveAttribute(String name)
    
public  voidsetAttribute(String name, Object o)
    
public  voidsetCharacterEncoding(String env)
     Can only be invoked in the event phase.


Constructor Detail
PortletServletRequest
public PortletServletRequest(PortletRequest portletRequest, PortletContext portletContext)(Code)




Method Detail
getAttribute
public Object getAttribute(String name)(Code)
Gets an attribute value on the PortletRequest . If the attribute name is javax.servlet.include.servlet_path, it returns the same as PortletServletRequest.getServletPath
See Also:   javax.servlet.ServletRequest.getAttribute(java.lang.String)



getAttributeNames
public Enumeration getAttributeNames()(Code)



getAuthType
public String getAuthType()(Code)



getCharacterEncoding
public String getCharacterEncoding()(Code)
Can only be invoked in the event phase.
See Also:   ServletRequest.getCharacterEncoding
throws:
  IllegalStateException - If the portlet is not in the event phase.



getContentLength
public int getContentLength()(Code)
Can only be invoked in the event phase.
See Also:   ServletRequest.getContentLength
throws:
  IllegalStateException - If the portlet is not in the event phase.



getContentType
public String getContentType()(Code)
Can only be invoked in the event phase.
See Also:   ServletRequest.getContentType
throws:
  IllegalStateException - If the portlet is not in the event phase.



getContextPath
public String getContextPath()(Code)



getCookies
public Cookie[] getCookies()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getDateHeader
public long getDateHeader(String name)(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getHeader
public String getHeader(String name)(Code)
Gets a property from the PortletRequest . Note that a PortletRequest is not guaranteed to map properties to headers.
See Also:   PortletRequest.getProperty(String)
See Also:   javax.servlet.http.HttpServletRequest.getHeader(java.lang.String)



getHeaderNames
public Enumeration getHeaderNames()(Code)
Gets the property names from the PortletRequest . Note that a PortletRequest is not guaranteed to map properties to headers.
See Also:   PortletRequest.getPropertyNames
See Also:   javax.servlet.http.HttpServletRequest.getHeaderNames



getHeaders
public Enumeration getHeaders(String name)(Code)
Gets the values for the specified property from the PortletRequest . Note that a PortletRequest is not guaranteed to map properties to headers.
See Also:   PortletRequest.getProperties(String)
See Also:   HttpServletRequest.getHeaders(String)



getInputStream
public ServletInputStream getInputStream() throws IOException(Code)
Can only be invoked in the event phase. When invoked in the event phase, it will wrap the portlet's InputStream as a PortletServletInputStream .
See Also:   ServletRequest.getInputStream
throws:
  IllegalStateException - If the portlet is not in the event phase.



getIntHeader
public int getIntHeader(String name)(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getLocalAddr
public String getLocalAddr()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getLocalName
public String getLocalName()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getLocalPort
public int getLocalPort()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getLocale
public Locale getLocale()(Code)



getLocales
public Enumeration getLocales()(Code)



getMethod
public String getMethod()(Code)



getParameter
public String getParameter(String name)(Code)



getParameterMap
public Map getParameterMap()(Code)



getParameterNames
public Enumeration getParameterNames()(Code)



getParameterValues
public String[] getParameterValues(String name)(Code)



getPathInfo
public String getPathInfo()(Code)



getPathTranslated
public String getPathTranslated()(Code)



getPortletRequest
public PortletRequest getPortletRequest()(Code)
Get the wrapped PortletRequest instance. The wrapped PortletRequest instance.



getProtocol
public String getProtocol()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getQueryString
public String getQueryString()(Code)



getReader
public BufferedReader getReader() throws IOException(Code)
Can only be invoked in the event phase.
See Also:   ServletRequest.getReader
throws:
  IllegalStateException - If the portlet is not in the event phase.



getRealPath
public String getRealPath(String path)(Code)



getRemoteAddr
public String getRemoteAddr()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getRemoteHost
public String getRemoteHost()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getRemotePort
public int getRemotePort()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getRemoteUser
public String getRemoteUser()(Code)



getRequestDispatcher
public RequestDispatcher getRequestDispatcher(String path)(Code)
Get the PortletRequestDispatcher as a PortletServletRequestDispatcher instance.
See Also:   javax.servlet.ServletRequest.getRequestDispatcher(java.lang.String)



getRequestURI
public String getRequestURI()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getRequestURL
public StringBuffer getRequestURL()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getRequestedSessionId
public String getRequestedSessionId()(Code)



getScheme
public String getScheme()(Code)



getServerName
public String getServerName()(Code)



getServerPort
public int getServerPort()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



getServletPath
public String getServletPath()(Code)
A 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.
See Also:   javax.servlet.http.HttpServletRequest.getServletPath



getSession
public HttpSession getSession()(Code)
Get the PortletSession as a PortletHttpSession instance.
See Also:   javax.servlet.http.HttpServletRequest.getSession



getSession
public HttpSession getSession(boolean create)(Code)
Get the PortletSession as a PortletHttpSession instance.
See Also:   javax.servlet.http.HttpServletRequest.getSession(boolean)



getUserPrincipal
public Principal getUserPrincipal()(Code)



isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()(Code)
Not allowed in a portlet.
throws:
  IllegalStateException - Not allowed in a portlet.



isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()(Code)



isSecure
public boolean isSecure()(Code)



isUserInRole
public boolean isUserInRole(String role)(Code)



removeAttribute
public void removeAttribute(String name)(Code)



setAttribute
public void setAttribute(String name, Object o)(Code)



setCharacterEncoding
public void setCharacterEncoding(String env) throws UnsupportedEncodingException(Code)
Can only be invoked in the event phase.
See Also:   ServletRequest.setCharacterEncoding(String)
throws:
  IllegalStateException - If the portlet is not in the event phase.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.