org.apache.tapestry.describe
Interface ReportStatusHub

All Known Implementing Classes:
ReportStatusHubImpl

public interface ReportStatusHub

Service for collecting together status information across the framework; service implementations implement the ReportStatusListener interface and register themselves as listeners here. When desired, the fireReportStatus(IMarkupWriter) event will invoke the listener method on each registered object.

Since:
4.0
Author:
Howard M. Lewis Ship

Method Summary
 void addReportStatusListener(ReportStatusListener listener)
          Adds the listener; listeners will be invoked in the order in which they are added.
 void fireReportStatus(IMarkupWriter writer)
          Generates an HTML status report by invoking ReportStatusListener.reportStatus(org.apache.tapestry.event.ReportStatusEvent) on each registered listener.
 void removeReportStatusListener(ReportStatusListener listener)
           
 

Method Detail

addReportStatusListener

void addReportStatusListener(ReportStatusListener listener)
Adds the listener; listeners will be invoked in the order in which they are added. Note: only service implementation that are singletons should be report status listeners. Threaded or pooled implementations should not be added; or should be careful to add and remove themselves from the hub directly.

Parameters:
listener -

removeReportStatusListener

void removeReportStatusListener(ReportStatusListener listener)

fireReportStatus

void fireReportStatus(IMarkupWriter writer)
Generates an HTML status report by invoking ReportStatusListener.reportStatus(org.apache.tapestry.event.ReportStatusEvent) on each registered listener.

Parameters:
writer - a markup writer to send the report to.


Copyright © 2006-2008 Apache Software Foundation. All Rights Reserved.