Package edu.internet2.middleware.grouper.app.gsh.template

Class GrouperTemplateReport

java.lang.Object
edu.internet2.middleware.grouper.app.gsh.template.GrouperTemplateReport
public abstract class GrouperTemplateReport extends Object
Base class for compiled Java GSH report templates (templateType=report, templateMode=compiled). The dispatcher — a compiled-template sub-branch inside ReportConfigType.GSH.retrieveReportDataByConfig — reads the configured GSH template id, resolves the compiled class through GshTemplateClassLoaderRegistry, instantiates a subclass of this class, and calls runReport with the GshReportRuntime populated. The dispatcher also assigns GshReportRuntime to its ThreadLocal before invoking, so helper code using GshReportRuntime.retrieveGshReportRuntime() continues to work. Authors populate report data via the runtime — typically gshReportRuntime.getGrouperReportData().setFile(...) and related accumulator methods. Context about the owning group/stem and subject is available on the runtime. Throw any exception to signal hard failure; the dispatcher records it on the report instance. GRP-7011

  • Constructor Details

    • GrouperTemplateReport

      public GrouperTemplateReport()

  • Method Details

    • runReport

      public abstract void runReport(GshReportRuntime gshReportRuntime)
      Override to produce the report's data.
      Parameters:
      gshReportRuntime - the runtime context — carries the owning group / stem, the report data accumulator, and the subject