How to use

PortletMessaging

in

org.apache.portals.messaging

protected void publishRenderMessage(PortletRequest request, String message, Object value)
{
  try
  {
    if (topic == null)
      PortletMessaging.publish(request, message, value);
    else
      PortletMessaging.publish(request, topic, message, value);
  }
  catch (Exception e)
  {}
}

protected Object consumeRenderMessage(PortletRequest request, String message)
{
  try
  {
    if (topic == null)
      return PortletMessaging.consume(request, message);            
    else
      return PortletMessaging.consume(request, topic, message);            
  }
  catch (Exception e)
  {}        
  return null;
}

protected Object receiveRenderMessage(PortletRequest request, String message)
{
  try
  {
    if (topic == null)
      return PortletMessaging.receive(request, message);
    else
      return PortletMessaging.receive(request, topic, message);
  }
  catch (Exception e)
  {}
  return null;
}

  WebContentHistoryList history = (WebContentHistoryList)PortletMessaging.receive(actionRequest, HISTORY);
WebContentHistoryList history = (WebContentHistoryList)PortletMessaging.receive(actionRequest, HISTORY);
if (history == null)
  history = new WebContentHistoryList();
history.visitPage(new WebContentHistoryPage(webContentURL,webContentParams,webContentMethod));
PortletMessaging.publish(actionRequest, HISTORY, history);

protected void cancelRenderMessage(PortletRequest request, String message)
{
  try
  {
    if (topic == null)
      PortletMessaging.cancel(request, message);
    else
      PortletMessaging.cancel(request, topic, message);
  }
  catch (Exception e)
  {}
}

  WebContentPageHistory history = (WebContentPageHistory)PortletMessaging.receive(actionRequest, HISTORY);
WebContentPageHistory history = (WebContentPageHistory)PortletMessaging.receive(actionRequest, HISTORY);
PortletMessaging.publish(actionRequest, HISTORY, history);

public void publishStatusMessage(PortletRequest request, String portlet, String topic, Throwable e, String message)
{
  String msg = message + ": " + e.toString();
  Throwable cause = e.getCause();
  if (cause != null)
  {
    msg = msg + ", " + cause.getMessage();
  }
  StatusMessage sm = new StatusMessage(msg, StatusMessage.ERROR);
  try
  {
    // TODO: fixme, bug in Pluto on portlet session
    PortletMessaging.publish(request, portlet, topic, sm);
  }
  catch (Exception ee)
  {
    System.err.println("Failed to publish message: " + e);
  }        
}

WebContentPageHistory history = (WebContentPageHistory)PortletMessaging.receive(request, HISTORY);
PortletMessaging.publish(request, HISTORY, history);

public void doEdit(RenderRequest request, RenderResponse response)
throws PortletException, IOException
{
  response.setContentType("text/html");
  StatusMessage msg = (StatusMessage)PortletMessaging.consume(request, "DatabaseBrowserPortlet", "dbConnectTest");
  if (msg != null)
  {
    this.getContext(request).put("statusMsg", msg);            
  }
  super.doEdit(request, response);
}

public String getURLSource(RenderRequest request, RenderResponse response, PortletPreferences prefs)
{
  String [] srcReplaceValues = { request.getServerName(), Integer.toString(request.getServerPort()), request.getContextPath() };
  
  String source = (String) PortletMessaging.receive(request, IFRAME_SRC_URL);
  
  if (source == null)
  {
    source = StringUtils.replaceEach(getAttributePreference(prefs, "SRC"), SRC_REPLACE_KEYS, srcReplaceValues);
  }
  
  // Sometimes, iframe's SRC attribute can be set to a local url to allow cross-domain scripting.
  // If proxy remote URL and its corresponding local path are set, then the proxy remote URL prefix
  // should be replaced by the local path.
  
  String proxyRemoteURL = StringUtils.replaceEach(getAttributePreference(prefs, "PROXYREMOTEURL"), SRC_REPLACE_KEYS, srcReplaceValues);
  String proxyLocalPath = StringUtils.replaceEach(getAttributePreference(prefs, "PROXYLOCALPATH"), SRC_REPLACE_KEYS, srcReplaceValues);
  
  if (StringUtils.isNotEmpty(proxyRemoteURL) && StringUtils.isNotEmpty(proxyLocalPath) && StringUtils.startsWith(source, proxyRemoteURL))
  {
    source = proxyLocalPath + source.substring(proxyRemoteURL.length());
  }
  
  return source;
}

public void publishStatusMessage(PortletRequest request, String portlet, String topic, Throwable e, String message)
{
  String msg = message + ": " + e.toString();
  Throwable cause = e.getCause();
  if (cause != null)
  {
    msg = msg + ", " + cause.getMessage();
  }
  StatusMessage sm = new StatusMessage(msg, StatusMessage.ERROR);
  try
  {
    // TODO: fixme, bug in Pluto on portlet session
    PortletMessaging.publish(request, portlet, topic, sm);
  }
  catch (Exception ee)
  {
    System.err.println("Failed to publish message: " + e);
  }
}

WebContentHistoryList history = (WebContentHistoryList)PortletMessaging.receive(request, HISTORY);
if (history == null)
  history = new WebContentHistoryList();
PortletMessaging.publish(request, HISTORY, history);

PortletPreferences prefs = request.getPreferences();
windowSize = Integer.parseInt(prefs.getValue(WINDOW_SIZE, "10"));
StatusMessage message = (StatusMessage) PortletMessaging.consume(request, "DatabaseBrowserPortlet", "action");
if (sortorder==null)

public String getURLSource(RenderRequest request, RenderResponse response, PortletPreferences prefs)
{
  String [] srcReplaceValues = { request.getServerName(), Integer.toString(request.getServerPort()), request.getContextPath() };
  
  String source = (String) PortletMessaging.receive(request, IFRAME_SRC_URL);
  
  if (source == null)
  {
    source = StringUtils.replaceEach(getAttributePreference(prefs, "SRC"), SRC_REPLACE_KEYS, srcReplaceValues);
  }
  
  // Sometimes, iframe's SRC attribute can be set to a local url to allow cross-domain scripting.
  // If proxy remote URL and its corresponding local path are set, then the proxy remote URL prefix
  // should be replaced by the local path.
  
  String proxyRemoteURL = StringUtils.replaceEach(getAttributePreference(prefs, "PROXYREMOTEURL"), SRC_REPLACE_KEYS, srcReplaceValues);
  String proxyLocalPath = StringUtils.replaceEach(getAttributePreference(prefs, "PROXYLOCALPATH"), SRC_REPLACE_KEYS, srcReplaceValues);
  
  if (StringUtils.isNotEmpty(proxyRemoteURL) && StringUtils.isNotEmpty(proxyLocalPath) && StringUtils.startsWith(source, proxyRemoteURL))
  {
    source = proxyLocalPath + source.substring(proxyRemoteURL.length());
  }
  
  return source;
}

public void publishStatusMessage(PortletRequest request, String portlet, String topic, Throwable e, String message)
{
  String msg = message + ": " + e.toString();
  Throwable cause = e.getCause();
  if (cause != null)
  {
    msg = msg + ", " + cause.getMessage();
  }
  StatusMessage sm = new StatusMessage(msg, StatusMessage.ERROR);
  try
  {
    // TODO: fixme, bug in Pluto on portlet session
    PortletMessaging.publish(request, portlet, topic, sm);
  }
  catch (Exception ee)
  {
    System.err.println("Failed to publish message: " + e);
  }
}

PortletPreferences prefs = request.getPreferences();
windowSize = Integer.parseInt(prefs.getValue(WINDOW_SIZE, "10"));
StatusMessage message = (StatusMessage) PortletMessaging.consume(request, "DatabaseBrowserPortlet", "action");
if (message != null)

Cookie[] cookies = (Cookie[])PortletMessaging.receive(request, HTTP_STATE);
if (cookies != null)

public void publishStatusMessage(PortletRequest request, String portlet, String topic, Throwable e, String message)
{
  String msg = message + ": " + e.toString();
  Throwable cause = e.getCause();
  if (cause != null)
  {
    msg = msg + ", " + cause.getMessage();
  }
  StatusMessage sm = new StatusMessage(msg, StatusMessage.ERROR);
  try
  {
    // TODO: fixme, bug in Pluto on portlet session
    PortletMessaging.publish(request, portlet, topic, sm);
  }
  catch (Exception ee)
  {
    System.err.println("Failed to publish message: " + e);
  }
}

StatusMessage message = (StatusMessage)PortletMessaging.consume(request, "DatabaseBrowserPortlet", "action");
if (message != null)

List<Cookie> cookies = (List<Cookie>) PortletMessaging.receive(request, HTTP_STATE);