portletrequest.html

门户开发

<DT><B>Returns:</B><DD>the client</DL>
</DD>
</DL>
<HR>

<A NAME="getParameter(java.lang.String)"><!-- --></A><H3>
getParameter</H3>
<PRE>
public java.lang.String <B>getParameter</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the value of the parameter with the given name,
 or <CODE>null</CODE> if no such parameter exists.

 <P>
 You should only use this method when you are sure the
 parameter has only one value. If not, use
 <CODE>getParameterValues(String)</CODE>

 <P>
 All parameter retrieval methods check for parameters that
 are namespaced by the portlet and for paramters that are
 not namespaced. If both exist, the namespaced parameter
 values are returned
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getParameter</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the parameter name
<DT><B>Returns:</B><DD>the parameter value<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterMap()"><CODE>getParameterMap()</CODE></A>, 
<A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterValues(java.lang.String)"><CODE>getParameterValues(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getParameterMap()"><!-- --></A><H3>
getParameterMap</H3>
<PRE>
public java.util.Map <B>getParameterMap</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns a map of the parameters of this request.

 <P>
 All parameter retrieval methods check for parameters that
 are namespaced by the portlet and for paramters that are
 not namespaced. If both exist, the namespaced parameter
 values are returned

 <P>
 Note that, for historical reasons, the values of the returned 
 map are Strings and not String arrays, altough this is is inconsistent
 with the behavior defined by <CODE>javax.servlet.ServletRequest</CODE>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getParameterMap</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a map of parameters; maps from String to String<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameter(java.lang.String)"><CODE>getParameter(String)</CODE></A>, 
<A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterValues(java.lang.String)"><CODE>getParameterValues(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getParameterNames()"><!-- --></A><H3>
getParameterNames</H3>
<PRE>
public java.util.Enumeration <B>getParameterNames</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns an enumeration of all parameter names. If this
 request

 <P>
 All parameter retrieval methods check for parameters that
 are namespaced by the portlet and for paramters that are
 not namespaced.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getParameterNames</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the enumeration</DL>
</DD>
</DL>
<HR>

<A NAME="getParameterValues(java.lang.String)"><!-- --></A><H3>
getParameterValues</H3>
<PRE>
public java.lang.String[] <B>getParameterValues</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the values of all parameters with the
 given name.

 <P>
 A request can carry more than one parameter with a
 certain name. This method returns these parameters
 in the order of appearance.

 <P>
 All parameter retrieval methods check for parameters that
 are namespaced by the portlet and for paramters that are
 not namespaced. If both exist, the namespaced parameter
 values are returned

 <P>
 Note that, for historical reasons, this method returns an
 empty String array and not <CODE>null</CODE> if the specified 
 parameter is not set, altough this is is inconsistent
 with the behavior defined by <CODE>javax.servlet.ServletRequest</CODE>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getParameterValues</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the parameter name
<DT><B>Returns:</B><DD>the array of parameter values<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameterMap()"><CODE>getParameterMap()</CODE></A>, 
<A HREF="../../../../org/apache/jetspeed/portlet/PortletRequest.html#getParameter(java.lang.String)"><CODE>getParameter(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
public void <B>setAttribute</B>(java.lang.String&nbsp;name,
                         java.lang.Object&nbsp;value)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Associates an attribute with the given name and value
 with this request. If a portlet needs to communicate
 information to embedded servlets or JSP, this methods
 can used carry the information along.

 <P>
 The portlet provider should take care that the
 the namespace of attribute names is not unnecessarily
 polluted. It is recommended to prefix all attributes
 the package and class name of the portlet that
 makes use of this method.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setAttribute</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the attribute name<DD><CODE>value</CODE> - the attribute value</DL>
</DD>
</DL>
<HR>

<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
removeAttribute</H3>
<PRE>
public void <B>removeAttribute</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Removes the attribute with the given name.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>removeAttribute</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of attribute to be removed</DL>
</DD>
</DL>
<HR>

<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
getAttribute</H3>
<PRE>
public java.lang.Object <B>getAttribute</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the value of the attribute with the given name,
 or <CODE>null</CODE> if no attribute with the given name exists.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getAttribute</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the attribute name
<DT><B>Returns:</B><DD>the attribute value</DL>
</DD>
</DL>
<HR>

<A NAME="getAttributeNames()"><!-- --></A><H3>
getAttributeNames</H3>
<PRE>
public java.util.Enumeration <B>getAttributeNames</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns an enumeration of names of all attributes available to
 this request. This method returns an empty enumeration if the
 request has no attributes available to it.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getAttributeNames</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an enumeration of attribute names</DL>
</DD>
</DL>
<HR>

<A NAME="isSecure()"><!-- --></A><H3>
isSecure</H3>
<PRE>
public boolean <B>isSecure</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns whether this request was made using a secure channel, such
 as HTTPS.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isSecure</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><CODE>true</CODE> if channel is secure, <BR>
           <CODE>false</CODE> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="getWindow()"><!-- --></A><H3>
getWindow</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletWindow.html" title="interface in org.apache.jetspeed.portlet">PortletWindow</A> <B>getWindow</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the window that the portlet is running in.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet window</DL>
</DD>
</DL>
<HR>

<A NAME="getData()"><!-- --></A><H3>
getData</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletData.html" title="interface in org.apache.jetspeed.portlet">PortletData</A> <B>getData</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the data of the concrete portlet instance
 <P>
 If the portlet is run in CONFIGURE mode, the
 portlet data is not accessible and this method will
 return <CODE>null</CODE>.
 </P>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet data</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletSession()"><!-- --></A><H3>
getPortletSession</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletSession.html" title="interface in org.apache.jetspeed.portlet">PortletSession</A> <B>getPortletSession</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the current session for the portlet or, if there is no current 
 portlet session, creates one and returns it.
 <P>
 This method should not be called when no portal session exists, i.e. when no user is
 logged in and the portlet is viewed on an anonymous page. In this case, the result may
 be a temporary session and session contents will be lost after the request completes.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet session</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletSession(boolean)"><!-- --></A><H3>
getPortletSession</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletSession.html" title="interface in org.apache.jetspeed.portlet">PortletSession</A> <B>getPortletSession</B>(boolean&nbsp;create)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Returns the current session for the portlet or, if there is no current 
 portlet session and the given flag is <CODE>true</CODE>, creates one and returns
 it.

 <P>
 If the given flag is <CODE>false</CODE> and there is no current session for the
 portal, this method returns <CODE>null</CODE>. If a session exists for the portal,
 but the portlet has not yet requested a session, a new portlet session will be 
 created.

 <P>
 This method should not be called with an argument value of <CODE>true</CODE> when no 
 portal session exists, i.e. when no user is
 logged in and the portlet is viewed on an anonymous page. In this case, the result may
 be a temporary session and session contents will be lost after the request completes.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>