propertybrokercontextpassingservice.html

门户开发

<A NAME="changedProperties(org.apache.jetspeed.portlet.PortletRequest, com.ibm.portal.ObjectID, com.ibm.wps.pb.property.PropertyValue[])"><!-- --></A><H3>
changedProperties</H3>
<PRE>
public void <B>changedProperties</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                              <A HREF="../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;targetPageId,
                              <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>[]&nbsp;pageContext)
                       throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD><p>
 This method is invoked to pass an array of property values (referred to as context)
 to be passed to portlets on the page identified by the target page id.
 The properties are delivered using the setProperties method
 to legacy portlets which implement the <code>com.ibm.wps.pb.portlet.PropertyListener</code> interface, and
 by using a special portlet action for JSR 168 compliant portlets which indicate that they wish
 to participate in receiving the context. 
 </p>
 <p>
 A legacy portlet which wishes to participate in
 receiving the context must set a  portlet config attribute named
 <code>com.ibm.portal.context.enable</code> and set its value to <code>true</code>. Such portlets
 will be passed the context through invocation of the <code>setProperties</code>
 method in the <code>com.ibm.wps.pb.portlet.PropertyListener</code> interface.
 
 The set of properties passed via the map may be filtered from the context if
 the target portlet indicates that additional filtering should be applied, as part of
 its deployment descriptor information. Filtering can be specified by using a
 portlet config attribute called <code>com.ibm.portal.context.filtertype</code>.
 Recognised values are "filter-none", when no filtering is applied;
 "filter-on-type", when filtering is applied on the property type,
 and "filter-on-name-and-type", when filtering is applied on property name and type.
 </p>
 <p>
 The context is scoped to the current user session, and is stored by the property broker
 from the time this method is invoked to the time the target page is next viewed in the session, at
 which point the context is distributed. 
 </p>
 <p>
 <code>PropertyBrokerServiceException</code> is thrown for any errors. It is an error
 to invoke this method more than once in a single request. This behavior may change
 in future releases.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - a <code>PortletRequest</code> object corresponding to the current portlet request 
 triggering the passing of the context<DD><CODE>targetPageId</CODE> - an <code>ObjectID</code> corresponding to the target page to which the context
 is to be passed<DD><CODE>pageContext</CODE> - an array of <code>PropertyValue</code> objects representing the context to be distributed
 to the portlets on the target page
<DT><B>Throws:</B>
<DD><CODE><code>PropertyBrokerServiceException</code></CODE> - if any error is encountered
 <p>
 The runtime exception <code>java.lang.IllegalArgumentException</code> is thrown if any of the values in
 the pageContext are not valid e.g. missing required fields
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property"><CODE>PropertyValue</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/portlet/PropertyListener.html" title="interface in com.ibm.wps.pb.portlet"><CODE>PropertyListener</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service"><CODE>PropertyBrokerServiceException</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="changedPropertiesForPortlet(org.apache.jetspeed.portlet.PortletRequest, com.ibm.portal.ObjectID, com.ibm.wps.pb.property.PropertyValue[])"><!-- --></A><H3>
changedPropertiesForPortlet</H3>
<PRE>
public void <B>changedPropertiesForPortlet</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                                        <A HREF="../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;targetPortletWindowId,
                                        <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>[]&nbsp;context)
                                 throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD><p>
 This method is invoked to pass an array of property values (referred to as context)
 to be passed to the portlet identified by the target portlet window id.
 The properties are delivered using the setProperties method
 to legacy portlets which implement the <code>com.ibm.wps.pb.portlet.PropertyListener</code> interface.
 </p>
 <p>
 A legacy portlet which wishes to participate in
 receiving the context must set a  portlet config attribute named
 <code>com.ibm.portal.context.enable</code> and set its value to <code>true</code>. Such portlets
 will be passed the context through invocation of the <code>setProperties</code>
 method in the <code>com.ibm.wps.pb.portlet.PropertyListener</code> interface.
 
 The set of properties passed via the map may be filtered from the context if
 the target portlet indicates that additional filtering should be applied, as part of
 its deployment descriptor information. Filtering can be specified by using a
 portlet config attribute called <code>com.ibm.portal.context.filtertype</code>.
 Recognised values are "filter-none", when no filtering is applied;
 "filter-on-type", when filtering is applied on the property type,
 and "filter-on-name-and-type", when filtering is applied on property name and type.
 </p>
 <p>
 This method must not be invoked outside of the event phase. The context will be distributed in the current event cycle.. 
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - a <code>PortletRequest</code> object corresponding to the current portlet request 
 triggering the passing of the context<DD><CODE>targetPortletWindowId</CODE> - an <code>ObjectID</code> corresponding to the target portlet window to which the context
 is to be passed<DD><CODE>context</CODE> - an array of <code>PropertyValue</code> objects representing the context to be distributed
 to the target portlet
<DT><B>Throws:</B>
<DD><CODE><code>PropertyBrokerServiceException</code></CODE> - if any error is encountered
 <p>
 The runtime exception <code>java.lang.IllegalArgumentException</code> is thrown if any of the values in
 the context are not valid e.g. missing required fields
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property"><CODE>PropertyValue</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/portlet/PropertyListener.html" title="interface in com.ibm.wps.pb.portlet"><CODE>PropertyListener</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service"><CODE>PropertyBrokerServiceException</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html" title="interface in com.ibm.wps.pb.service"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PropertyBrokerContextPassingService.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>