propertybrokercontextpassingservice.html

门户开发

                              javax.portlet.ActionResponse response,
                              <A HREF="../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;targetPageId,
                              <A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyValue.html" title="interface in com.ibm.portal.propertybroker.property">PropertyValue</A>[]&nbsp;pageContext)
                       throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyBrokerServiceException.html" title="class in com.ibm.portal.propertybroker.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 next time the target page is viewed, the properties are delivered to portlets which have
 indicated through special settings that they are enabled for receiving context. For such
 portlets, the context is delivered (with possibly some additional filtering), 
 using the <code>setProperties</code> method
  in the <code>com.ibm.wps.pb.portlet.PropertyListener</code> interface, 
 for portlets written to the IBM portlet API, and
 by using a special portlet action for JSR 168 compliant portlets.   
 </p>
 <p>
 A JSR-168 compliant portlet which wishes to participate in
 receiving the context must provide a read-only preference 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>processAction</code>
 method, with an action request parameter named <code>com.ibm.portal.action</code> set to a value of
 <code>com.ibm.portal.context.receive</code>. A portlet written to the IBM
 portlet API needs to specify the attribute using a portlet configuration setting.
 </p>
 <p>
 The context is passed as a 
 <code>java.util.Map</code> object, set as an action request
 attribute named <code>com.ibm.portal.context</code>.
 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. By default, no filtering is applied,
 but additional filtering will be applied if a read-only preference attribute named
 <code>com.ibm.portal.context.filter.type</code> is set to one of the following values:
 <br>
 <code>filter-none</code> - this indicates no filtering, which is the default
 <br>
 <code>filter-on-type</code> - the context will be filtered so that only the entries whose
 property type matches the type of a registered input property for the portlet will be delivered
 <br>
 <code>filter-on-name-and-type</code> - the type-based filtering of <code>filter-on-type</code>
 will be applied, but, in addition, the filtered property must match on the name attribute as well
 <br>
 A portlet written to the IBM portlet API can also specify the same values for
 the filter type, using a portlet configuration setting with the same name.
 </p>
 <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. 
 A context can be set only once in a request. Subsequent attempts to set contexts
 will result in <code>PropertyBrokerServiceException</code> being thrown. 
 This behavior may change in future releases.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - an <code>ActionRequest</code> object corresponding to the current action request<DD><CODE>response</CODE> - an <code>ActionResponse</code> object corresponding to the current action response<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 problem 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/portal/propertybroker/service/PropertyBrokerServiceException.html" title="class in com.ibm.portal.propertybroker.service">PropertyBrokerServiceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyValue.html" title="interface in com.ibm.portal.propertybroker.property"><CODE>PropertyValue</CODE></A>, 
<A HREF="../../../../../com/ibm/portal/propertybroker/property/Property.html" title="interface in com.ibm.portal.propertybroker.property"><CODE>Property</CODE></A>, 
<A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyFilterType.html" title="class in com.ibm.portal.propertybroker.property"><CODE>PropertyFilterType</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/portal/propertybroker/service/PropertyBrokerServiceException.html" title="class in com.ibm.portal.propertybroker.service"><CODE>PropertyBrokerServiceException</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="changedPropertiesForPortlet(javax.portlet.ActionRequest, javax.portlet.ActionResponse, com.ibm.portal.ObjectID, com.ibm.portal.propertybroker.property.PropertyValue[])"><!-- --></A><H3>
changedPropertiesForPortlet</H3>
<PRE>
public void <B>changedPropertiesForPortlet</B>(javax.portlet.ActionRequest&nbsp;request,
                                        javax.portlet.ActionResponse&nbsp;response,
                                        <A HREF="../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;targetPortletWindowId,
                                        <A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyValue.html" title="interface in com.ibm.portal.propertybroker.property">PropertyValue</A>[]&nbsp;context)
                                 throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyBrokerServiceException.html" title="class in com.ibm.portal.propertybroker.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 a portlet on the current page, identified by the target portlet window id.
 The properties will be delivered to the target portletin the current event cycle. The target must have
 indicated through special settings that it is enabled for receiving context. For such
 portlets, the context is delivered (with possibly some additional filtering), 
 using a special portlet action for JSR 168 compliant portlets.   
 </p>
 <p>
 A JSR 168 compliant portlet which wishes to participate in
 receiving the context must provide a read-only preference 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>processAction</code>
 method, with an action request parameter named <code>com.ibm.portal.action</code> set to a value of
 <code>com.ibm.portal.context.receive</code>. 
 </p>
 <p>
 The context is passed as a 
 <code>java.util.Map</code> object, set as an action request
 attribute named <code>com.ibm.portal.context</code>.
 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. By default, no filtering is applied,
 but additional filtering will be applied if a read-only preference attribute named
 <code>com.ibm.portal.context.filter.type</code> is set to one of the following values:
 <br>
 <code>filter-none</code> - this indicates no filtering, which is the default
 <br>
 <code>filter-on-type</code> - the context will be filtered so that only the entries whose
 property type matches the type of a registered input property for the portlet will be delivered
 <br>
 <code>filter-on-name-and-type</code> - the type-based filtering of <code>filter-on-type</code>
 will be applied, but, in addition, the filtered property must match on the name attribute as well
 <br>
 
 </p>
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - an <code>ActionRequest</code> object corresponding to the current action request<DD><CODE>response</CODE> - an <code>ActionResponse</code> object corresponding to the current action response<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 problem is encountered
 </p>
 <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/portal/propertybroker/service/PropertyBrokerServiceException.html" title="class in com.ibm.portal.propertybroker.service">PropertyBrokerServiceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyValue.html" title="interface in com.ibm.portal.propertybroker.property"><CODE>PropertyValue</CODE></A>, 
<A HREF="../../../../../com/ibm/portal/propertybroker/property/Property.html" title="interface in com.ibm.portal.propertybroker.property"><CODE>Property</CODE></A>, 
<A HREF="../../../../../com/ibm/portal/propertybroker/property/PropertyFilterType.html" title="class in com.ibm.portal.propertybroker.property"><CODE>PropertyFilterType</CODE></A>, 
<A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyBrokerServiceException.html" title="class in com.ibm.portal.propertybroker.service"><CODE></p></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/portal/propertybroker/service/PropertyBrokerService.html" title="interface in com.ibm.portal.propertybroker.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>