SummaryDelegate

public interface SummaryDelegate

Custom delegate interface for use with SummaryMBean via SummaryDelegateFactory implementations.

Supported API: true

Extendable: true

Method Summary

Modifier and Type

Method

Description

void

postSummarize()

Method called by SummaryMBean both upon periodic summary logging and when computing the InfoItemsPreview attribute (via getInfoItemsPreview()).

boolean

preSummarize(SummaryMBean mbean, boolean previewMode, boolean willOutputInfo)

Method called by SummaryMBean both upon periodic summary logging and when computing the InfoItemsPreview attribute (via getInfoItemsPreview()).

Method Details
- preSummarize
  
  boolean preSummarize(SummaryMBean mbean, boolean previewMode, boolean willOutputInfo)
  
  Method called by SummaryMBean both upon periodic summary logging and when computing the InfoItemsPreview attribute (via getInfoItemsPreview()). In both cases, this method is called prior to any retrieval of JMX attribute data for output purposes.
  
  Supported API: true
  
  Parameters:
  
  mbean - SummaryMBean from which this delegate is being called
  
  previewMode - Whether this method is being called from getInfoItemsPreview()
  
  willOutputInfo - Whether the SummaryMBean would produce output on its own
  
  Returns:
  
  Whether SummaryMBean should still produce output; result is ignored when called from getInfoItemsPreview()
- postSummarize
  
  void postSummarize()
  
  Method called by SummaryMBean both upon periodic summary logging and when computing the InfoItemsPreview attribute (via getInfoItemsPreview()). In both cases, this method is called after any retrieval of JMX attribute data for output purposes.
  Note that this will be the same instance of this class upon which the corresponding preSummarize() call was made and that separate instances are used otherwise -- so one can place data in the instance in preSummarize() for use in this routine.
  
  Supported API: true