Java Doc for ActionRequest.java in  » Portal » Open-Portal » javax » portlet » 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 » javax.portlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.portlet.ActionRequest

All known Subclasses:   com.sun.portal.portlet.impl.ActionRequestImpl,
ActionRequest
public interface ActionRequest extends PortletRequest(Code)
The ActionRequest represents the request sent to the portlet to handle an action. It extends the PortletRequest interface to provide action request information to portlets.
The portlet container creates an ActionRequest object and passes it as argument to the portlet's processAction method.
See Also:   PortletRequest
See Also:   RenderRequest




Method Summary
public  java.lang.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 which is made available by the input stream, or -1 if the length is not known.
public  java.lang.StringgetContentType()
     Returns the MIME type of the body of the request, or null if the type is not known.
public  java.io.InputStreamgetPortletInputStream()
     Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.
public  java.io.BufferedReadergetReader()
     Retrieves the body of the HTTP request from the client to the portal as character data using a BufferedReader.
public  voidsetCharacterEncoding(String enc)
     Overrides the name of the character encoding used in the body of this request.



Method Detail
getCharacterEncoding
public java.lang.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 which is 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 java.lang.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.



getPortletInputStream
public java.io.InputStream getPortletInputStream() throws java.io.IOException(Code)
Retrieves the body of the HTTP request from client to portal as binary data using an InputStream. Either this method or ActionRequest.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:
  java.io.IOException - if an input or output exception occurred




getReader
public java.io.BufferedReader getReader() throws java.io.UnsupportedEncodingException, java.io.IOException(Code)
Retrieves the body of the HTTP request from the 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 ActionRequest.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 ActionRequest.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:   ActionRequest.getPortletInputStream




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 ActionRequest.getReader or ActionRequest.getPortletInputStream .

This method only sets the character set for the Reader that the ActionRequest.getReader method returns.
Parameters:
  enc - a String containing the name of the chararacter encoding.
exception:
  java.io.UnsupportedEncodingException - if this is not a valid encoding
exception:
  java.lang.IllegalStateException - if this method is called after reading request parameters or reading input using getReader()




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