|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.render.http.ServletPortletRenderRequest
public class ServletPortletRenderRequest
ServletPortletRenderRequest
is the JPDK's base implementation
of the PortletRenderRequest
interface. It represents a PortletRenderRequest
running in a servlet
environment.
Field Summary |
---|
Fields inherited from interface oracle.portal.provider.v2.render.PortletRenderRequest |
---|
IS_PORTLET |
Constructor Summary | |
---|---|
ServletPortletRenderRequest(PortletReference ref,
ProviderUser user,
RenderContext rc)
Constructs a ServletPortletRenderRequest . |
Method Summary | |
---|---|
java.lang.String[] |
getAcceptContentTypes()
|
java.lang.Object |
getAttribute(java.lang.String name)
Data can be passed between object in a request via attr/value pairs hung off the RequestContext. |
java.util.Enumeration |
getAttributeNames()
Get the names of the attributes of this ServletPortletRenderRequest as an Enumeration
of String s. |
java.lang.String |
getContentType()
Gets the current contentType for this request's response. |
java.lang.Object[] |
getCookies()
A session is an object that maintains state across requests. |
java.util.Locale |
getDefaultLocale()
Returns the Portal's default Locale. |
java.util.Locale |
getLocale()
The preferred Java Locale to be used for this response. |
java.util.Enumeration |
getLocales()
Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. |
int |
getMode()
|
java.lang.String |
getOriginalHeader(java.lang.String name)
If this is a mobile request iAS Wireless will have overwritten some of the client's original HTTP headers: specifically the Accept and the UserAgent header. |
java.lang.String |
getParameter(java.lang.String name)
Returns the request parameter of the given name. |
java.util.Enumeration |
getParameterNames()
Returns an enumeration containing the parameter names passed in this request. |
java.lang.String[] |
getParameterValues(java.lang.String name)
Returns the values for the named request parameter. |
PortletDefinition |
getPortletDefinition()
Gets the PortletDefinition associated with this request. |
PortletInstance |
getPortletInstance()
|
PortletReference |
getPortletReference()
|
java.lang.String |
getPreferredContentType()
|
ProviderInstance |
getProviderInstance()
Gets the ProviderInstance associated with this request. |
java.util.ResourceBundle |
getProviderResource()
Returns the Provider resource associated with the Locale of this request. |
java.lang.String |
getQualifiedParameter(java.lang.String name)
Returns the qualified request parameter of the given non-qualified name. |
java.util.Enumeration |
getQualifiedParameterNames()
Against a 309 Portal this returns an enumeration containing only those parameter names that match this portlets fully qualified name. |
java.lang.String[] |
getQualifiedParameterValues(java.lang.String name)
Returns the qualified request parameter values of the given non-qualified name. |
RenderContext |
getRenderContext()
|
java.lang.String |
getRequestURL()
|
java.lang.String |
getScheme()
The scheme we are running in. |
java.lang.String |
getServerName()
Server name. |
int |
getServerPort()
Port used by this server. |
ProviderSession |
getSession()
A session is an object that maintains state across requests. |
java.lang.String |
getURLCharSet()
Returns the character set that was used when the parameters of the request were encoded. |
ProviderUser |
getUser()
Gets the user making this request. |
java.lang.String |
getUserAgent()
The user agent that originated this request. |
java.io.PrintWriter |
getWriter()
Returns a PrintWriter used to emit this request's response. |
java.io.PrintWriter |
getWriter(java.lang.String contentType)
Returns a PrintWriter used to emit this request's response. |
void |
removeAttribute(java.lang.String name)
Removes an existing attribute. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Data can be passed between object in a request via attr/value pairs hung off the RequestContext. |
void |
setContentType(java.lang.String contentType)
Sets the contentType for this request's response. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServletPortletRenderRequest(PortletReference ref, ProviderUser user, RenderContext rc)
ServletPortletRenderRequest
.
Method Detail |
---|
public RenderContext getRenderContext()
getRenderContext
in interface PortletRenderRequest
PortletRenderRequest
public int getMode()
getMode
in interface PortletRenderRequest
PortletRenderer
interface.public java.lang.String getRequestURL() throws java.lang.IllegalStateException
getRequestURL
in interface PortletRenderRequest
java.lang.IllegalStateException
public java.lang.String[] getAcceptContentTypes() throws java.lang.IllegalStateException
getAcceptContentTypes
in interface PortletRenderRequest
java.lang.IllegalStateException
public java.lang.String getPreferredContentType() throws java.lang.IllegalStateException
getPreferredContentType
in interface PortletRenderRequest
java.lang.IllegalStateException
public PortletReference getPortletReference()
getPortletReference
in interface PortletRenderRequest
public PortletInstance getPortletInstance()
getPortletInstance
in interface PortletRenderRequest
public ProviderUser getUser()
getUser
in interface PortletRenderRequest
public java.lang.String getOriginalHeader(java.lang.String name)
getOriginalHeader
in interface PortletRenderRequest
name
- the header name you want the original value for. I.e. if
you pass "Accept" you will receive the original value of "Accept"
whether its been overwritten or not.public ProviderInstance getProviderInstance()
getProviderInstance
in interface PortletRenderRequest
public PortletDefinition getPortletDefinition()
getPortletDefinition
in interface PortletRenderRequest
public java.lang.String getScheme()
getScheme
in interface PortletRenderRequest
public java.lang.String getUserAgent()
getUserAgent
in interface PortletRenderRequest
public java.lang.String getServerName()
getServerName
in interface PortletRenderRequest
public int getServerPort()
getServerPort
in interface PortletRenderRequest
public java.lang.String getParameter(java.lang.String name)
getParameter
in interface PortletRenderRequest
name
- the name of the parameter whose value is requested.public java.lang.String getQualifiedParameter(java.lang.String name)
Fully-qualified parameter names are somewhat inconvenient to use because they are dynamic. I.e. they are isntance-based. This method helps to overcome this inconvenience by allowing you to retrieve the fully qualified parameter name value passing only the non-qualified name.
As with getParameter(), if there are duplicates the first value is returned. Returned Parameter values are encoded using the RequestContext's encoding. By default this is ISO-8859-1.
getQualifiedParameter
in interface PortletRenderRequest
name
- the unqualfied name of the parameter whose value is
requested.
public java.lang.String[] getParameterValues(java.lang.String name)
getParameterValues
in interface PortletRenderRequest
name
- the name of the parameter whose value is requested.
public java.lang.String[] getQualifiedParameterValues(java.lang.String name)
Fully-qualified parameter names are somewhat inconvenient to use because they are dynamic. I.e. they are isntance-based. This method helps to overcome this inconvenience by allowing you to retrieve the fully qualified parameter name value passing only the non-qualified name.
Returned Parameter values are encoded using the RequestContext's encoding. By default this is ISO-8859-1.
getQualifiedParameterValues
in interface PortletRenderRequest
name
- the unqualfied name of the parameter whose value is
requested.
public java.util.Enumeration getParameterNames()
getParameterNames
in interface PortletRenderRequest
public java.util.Enumeration getQualifiedParameterNames()
getQualifiedParameterNames
in interface PortletRenderRequest
public void setContentType(java.lang.String contentType)
setContentType
in interface PortletRenderRequest
public java.lang.String getContentType()
getContentType
in interface PortletRenderRequest
public java.io.PrintWriter getWriter(java.lang.String contentType) throws java.io.IOException
Note:
if null is passed the content type of the response is set to "text/html". The character encoding used is based on the default encoding of the request.
After the first call to any of the getWriter() methods the content type cannot be changed.
getWriter
in interface PortletRenderRequest
java.io.IOException
public java.io.PrintWriter getWriter() throws java.io.IOException
Note:
Uses the content type specified by calling setContentType() or defaults the content type of the response to "text/html". The character encoding used is based on the default encoding of the request.
After the first call to any of the getWriter() methods the content type and character encoding cannot be changed.
getWriter
in interface PortletRenderRequest
java.io.IOException
public java.util.Locale getLocale()
getLocale
in interface PortletRenderRequest
public java.util.Enumeration getLocales()
getLocales
in interface PortletRenderRequest
public java.util.Locale getDefaultLocale()
null
. When
null
or when the portlet doesn't support this locale the
Portlet's default Locale should be used. This is accessible via the
Portlet interface (getDefaultLocale()
). Alternatively,
you might consider using the getDefaultLocale()
method in
the PortletReference
interface. This method is defined to
return the Portlet's default locale if the Portal hasn't passed one.
getDefaultLocale
in interface PortletRenderRequest
public java.util.ResourceBundle getProviderResource()
getProviderResource
in interface PortletRenderRequest
public ProviderSession getSession()
getSession
in interface PortletRenderRequest
public java.lang.Object[] getCookies()
getCookies
in interface PortletRenderRequest
public void setAttribute(java.lang.String name, java.lang.Object value)
setAttribute
in interface PortletRenderRequest
name
- the name of the attribute.value
- the value for the attribute.public java.lang.Object getAttribute(java.lang.String name)
getAttribute
in interface PortletRenderRequest
name
- the name of the attribute.
public java.util.Enumeration getAttributeNames()
ServletPortletRenderRequest
as an Enumeration
of String
s.
getAttributeNames
in interface PortletRenderRequest
public void removeAttribute(java.lang.String name)
removeAttribute
in interface PortletRenderRequest
name
- the name of the attribute.public java.lang.String getURLCharSet()
getURLCharSet
in interface PortletRenderRequest
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |