|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientDataRequest
The ClientDataRequest
represents the request information of the HTTP request issued from the client to the portal.
It extends the PortletRequest interface.
PortletRequest
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest |
---|
PortletRequest.P3PUserInfos |
Field Summary |
---|
Fields inherited from interface javax.portlet.PortletRequest |
---|
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO |
Method Summary | |
---|---|
String |
getCharacterEncoding() Returns the name of the character encoding used in the body of this request. |
int |
getContentLength() 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. |
String |
getContentType() Returns the MIME type of the body of the request, or null if the type is not known. |
String |
getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
InputStream |
getPortletInputStream() Retrieves the body of the HTTP request from client to portal as binary data using an InputStream . |
BufferedReader |
getReader() Retrieves the body of the HTTP request from the client to the portal as character data using a BufferedReader . |
void |
setCharacterEncoding(String enc) Overrides the name of the character encoding used in the body of this request. |
Method Detail |
---|
InputStream getPortletInputStream() throws IOException
InputStream
. Either this method or 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.
IllegalStateException
- if getReader was already called, or it is a HTTP POST data of type application/x-www-form-urlencodedIOException
- if an input or output exception occurredvoid setCharacterEncoding(String enc) throws UnsupportedEncodingException
getReader()
or getPortletInputStream()
.
This method only sets the character set for the Reader that the getReader()
method returns.
enc
- a String
containing the name of the character encoding.UnsupportedEncodingException
- if this is not a valid encodingIllegalStateException
- if this method is called after reading request parameters or reading input using getReader()
BufferedReader getReader() throws UnsupportedEncodingException, IOException
BufferedReader
. The reader translates the character data according to the character encoding used on the body. Either this method or 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.
BufferedReader
containing the body of the requestUnsupportedEncodingException
- if the character set encoding used is not supported and the text cannot be decodedIllegalStateException
- if getPortletInputStream()
method has been called on this request, it is a HTTP POST data of type application/x-www-form-urlencoded.IOException
- if an input or output exception occurredgetPortletInputStream()
String getCharacterEncoding()
null
if the request does not specify a character encoding.String
containing the name of the character encoding, or null
if the request does not specify a character encoding.String getContentType()
String
containing the name of the MIME type of the request, or null if the type is not known.int getContentLength()
String getMethod()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.