Java Doc for ActionRequestImpl.java in  » Portal » Open-Portal » com » sun » portal » portlet » impl » 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 » Portal » Open Portal » com.sun.portal.portlet.impl 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.portal.portlet.impl.PortletRequestImpl
      com.sun.portal.portlet.impl.ActionRequestImpl

ActionRequestImpl
public class ActionRequestImpl extends PortletRequestImpl implements javax.portlet.ActionRequest(Code)
This class provides implementation of the ActionRequest interface.




Method Summary
 voidclear()
     Clears the global variables.
public  StringgetCharacterEncoding()
     Returns the name of the character encoding used in the body of this request.
public  intgetContentLength()
     Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
public  StringgetContentType()
     Returns the MIME type of the body of the request, or null if the type is not known.
public  java.util.MapgetParameterMap()
     Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. The returned parameters are "x-www-form-urlencoded" decoded.

The values in the returned Map are from type String array (String[]).

If no parameters exist this method returns an empty Map. an immutable Map containing parameter names askeys and parameter values as map values, or an empty Mapif no parameters exist.

public  java.io.InputStreamgetPortletInputStream()
     Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.
public  PortletModegetPortletMode()
     Returns the current mode of the portlet.
public  BufferedReadergetReader()
     Retrieves the body of the HTTP request from client to the portal as character data using a BufferedReader.
public  WindowStategetWindowState()
     Returns the current window state of the portlet.
 voidinit(HttpServletRequest req, HttpServletResponse res, PortletContainerActionRequest pContReq, PortletContainerActionResponse pContRes, PortletContext context, PortalContext portalContext, PortletDescriptor pDescriptor, StringWriter writer, Logger logger)
     Initialize the global variables.
public  voidsetCharacterEncoding(String enc)
     Overrides the name of the character encoding used in the body of this request.



Method Detail
clear
void clear()(Code)
Clears the global variables.



getCharacterEncoding
public String getCharacterEncoding()(Code)
Returns the name of the character encoding used in the body of this request. This method returns null if the request does not specify a character encoding. a String containing the name of the chararacter encoding, or nullif the request does not specify a character encoding.



getContentLength
public int getContentLength()(Code)
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. an integer containing the length of the request body or -1 if the length is not known



getContentType
public String getContentType()(Code)
Returns the MIME type of the body of the request, or null if the type is not known. a String containing the name of the MIME type of the request, or null if the type is not known



getParameterMap
public java.util.Map getParameterMap()(Code)
Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. The returned parameters are "x-www-form-urlencoded" decoded.

The values in the returned Map are from type String array (String[]).

If no parameters exist this method returns an empty Map. an immutable Map containing parameter names askeys and parameter values as map values, or an empty Mapif no parameters exist. The keys in the parametermap are of type String. The values in the parameter map are of typeString array (String[]).




getPortletInputStream
public java.io.InputStream getPortletInputStream() throws IOException(Code)
Retrieves the body of the HTTP request from client to portal as binary data using an InputStream. Either this method or ActionRequestImpl.getReader may be called to read the body, but not both.

For HTTP POST data of type application/x-www-form-urlencoded this method throws an IllegalStateException as this data has been already processed by the portal/portlet-container and is available as request parameters. an input stream containing the body of the request
exception:
  java.lang.IllegalStateException - if getReader was already called, or it is a HTTP POST data of type application/x-www-form-urlencoded
exception:
  IOException - if an input or output exception occurred




getPortletMode
public PortletMode getPortletMode()(Code)
Returns the current mode of the portlet. the portlet mode



getReader
public BufferedReader getReader() throws java.io.UnsupportedEncodingException, java.io.IOException(Code)
Retrieves the body of the HTTP request from client to the portal as character data using a BufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method or ActionRequestImpl.getPortletInputStream may be called to read the body, not both.

For HTTP POST data of type application/x-www-form-urlencoded this method throws an IllegalStateException as this data has been already processed by the portal/portlet-container and is available as request parameters. a BufferedReadercontaining the body of the request
exception:
  java.io.UnsupportedEncodingException - if the character set encoding used is not supported and the text cannot be decoded
exception:
  java.lang.IllegalStateException - if ActionRequestImpl.getPortletInputStream methodhas been called on this request, it is a HTTP POST data of type application/x-www-form-urlencoded.
exception:
  java.io.IOException - if an input or output exception occurred
See Also:   ActionRequestImpl.getInputStream




getWindowState
public WindowState getWindowState()(Code)
Returns the current window state of the portlet. the window state



init
void init(HttpServletRequest req, HttpServletResponse res, PortletContainerActionRequest pContReq, PortletContainerActionResponse pContRes, PortletContext context, PortalContext portalContext, PortletDescriptor pDescriptor, StringWriter writer, Logger logger)(Code)
Initialize the global variables.


Parameters:
  req - The HttpServletRequest of the PAE
Parameters:
  res - The HttpServletResponse of the PAE
Parameters:
  pContReq - The PortletContainerRequest
Parameters:
  logger - The Logger object




setCharacterEncoding
public void setCharacterEncoding(String enc) throws java.io.UnsupportedEncodingException(Code)
Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading input using ActionRequestImpl.getReader or ActionRequestImpl.getPortletInputStream .


Parameters:
  enc - a String containing the name of the chararacter encoding.
exception:
  java.io.UnsupportedEncodingException - if thisis not a valid encoding
exception:
  java.lang.IllegalStateException - if this method is called after reading request parameters or reading input using getReader()




Methods inherited from com.sun.portal.portlet.impl.PortletRequestImpl
void clear()(Code)(Java Doc)
public Object getAttribute(String name)(Code)(Java Doc)
public Enumeration getAttributeNames()(Code)(Java Doc)
public String getAuthType()(Code)(Java Doc)
public String getContextPath()(Code)(Java Doc)
public java.util.Locale getLocale()(Code)(Java Doc)
public java.util.Enumeration getLocales()(Code)(Java Doc)
public String getParameter(String name)(Code)(Java Doc)
public java.util.Map getParameterMap()(Code)(Java Doc)
public Enumeration getParameterNames()(Code)(Java Doc)
public String[] getParameterValues(String name)(Code)(Java Doc)
public PortalContext getPortalContext()(Code)(Java Doc)
public PortletMode getPortletMode()(Code)(Java Doc)
public PortletSession getPortletSession()(Code)(Java Doc)
public PortletSession getPortletSession(boolean create)(Code)(Java Doc)
public PortletPreferences getPreferences()(Code)(Java Doc)
public Enumeration getProperties(String name)(Code)(Java Doc)
public String getProperty(String name)(Code)(Java Doc)
public Enumeration getPropertyNames()(Code)(Java Doc)
public String getRemoteUser()(Code)(Java Doc)
public String getRequestedSessionId()(Code)(Java Doc)
public String getResponseContentType()(Code)(Java Doc)
public java.util.Enumeration getResponseContentTypes()(Code)(Java Doc)
public String getScheme()(Code)(Java Doc)
public String getServerName()(Code)(Java Doc)
public int getServerPort()(Code)(Java Doc)
public java.security.Principal getUserPrincipal()(Code)(Java Doc)
public WindowState getWindowState()(Code)(Java Doc)
void init(HttpServletRequest req, HttpServletResponse res, PortletContainerRequest pContReq, PortletContainerResponse pContRes, PortletContext context, PortalContext portalContext, PortletDescriptor pDescriptor, Logger logger)(Code)(Java Doc)
public boolean isPortletModeAllowed(PortletMode portletMode)(Code)(Java Doc)
public boolean isRequestedSessionIdValid()(Code)(Java Doc)
public boolean isSecure()(Code)(Java Doc)
public boolean isUserInRole(String role)(Code)(Java Doc)
public boolean isWindowStateAllowed(WindowState state)(Code)(Java Doc)
public void removeAttribute(String name)(Code)(Java Doc)
public void setAttribute(String name, Object o)(Code)(Java Doc)

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.