Class SecurityInspectorReport<TRow,TColumnGroup,TColumnItem,TEntryReport>

java.lang.Object
org.jenkinsci.plugins.securityinspector.model.SecurityInspectorReport<TRow,TColumnGroup,TColumnItem,TEntryReport>
Type Parameters:
TRow - Class of the Rows in the report
TColumnGroup - Class of the column group definitions
TColumnItem - Class of item reports within a group
TEntryReport - Class of the stored entries
Direct Known Subclasses:
PermissionReport

public abstract class SecurityInspectorReport<TRow,TColumnGroup,TColumnItem,TEntryReport> extends Object
Basic class for reports being generated by the plugin. This class implements the following report format:
  • The report is being returned as a table
  • Columns are grouped into several groups
  • Rows are not grouped
This format gives a 3-dimensional report, all element types can be specified by generics.
Author:
Ksenia Nenasheva
  • Method Details

    • getReportTargetName

      @Nonnull public abstract String getReportTargetName()
      Get report target name (e.g. user or job)
      Returns:
      localisable full display name
    • getEntries

      @Nonnull public org.apache.commons.collections.map.MultiKeyMap getEntries()
    • getGroups

      @Nonnull public Set<TColumnGroup> getGroups()
    • getRows

      @Nonnull public Set<TRow> getRows()
    • getColumns

      @Nonnull public Set<TColumnItem> getColumns()
    • getEntry

      @CheckForNull public final TEntryReport getEntry(@Nonnull TRow row, @Nonnull TColumnItem column)
    • forRow

      public void forRow(@Nonnull TRow row, @Nonnull Runnable runnable)
    • generateReport

      public final void generateReport(@Nonnull Set<TRow> rows, @Nonnull Set<TColumnItem> columns, @Nonnull Set<TColumnGroup> groups)
    • fillRowByResult

      protected final void fillRowByResult(@Nonnull TRow row, TEntryReport result)
    • getRowComparator

      @Nonnull public Comparator<TRow> getRowComparator()
    • getColumnComparator

      @Nonnull public Comparator<TColumnItem> getColumnComparator()
    • getGroupOfItem

      @Nonnull public abstract TColumnGroup getGroupOfItem(@Nonnull TColumnItem item)
      Retrieve a group for an item.
      Parameters:
      item - Item to be analyzed
      Returns:
      Assigned group. Never null
    • getItemsOfGroup

      @Nonnull public abstract Collection<TColumnItem> getItemsOfGroup(@Nonnull TColumnGroup group)
      Retrieves items for a group.
      Parameters:
      group - Group
      Returns:
      Collection of items. May be empty, but never null
    • getEntryReport

      @Nonnull protected abstract TEntryReport getEntryReport(@Nonnull TRow row, @Nonnull TColumnItem item)
      Retrieves an entry for the specified row and column values.
      Parameters:
      row - Row
      item - Column
      Returns:
      Entry for the report table
    • getRowColumnHeader

      @Nonnull public abstract String getRowColumnHeader()
      Returns display name for the row grouping cell.
      Returns:
      Localizable text for the column header
    • getRowTitle

      @Nonnull public abstract String getRowTitle(@Nonnull TRow row)
      Retrieves a title for the specified row.
      Parameters:
      row - Row
      Returns:
      Localizable text title
    • getGroupTitle

      @Nonnull public abstract String getGroupTitle(@Nonnull TColumnGroup group)
      Retrieves a title for the specified group.
      Parameters:
      group - Group
      Returns:
      Localizable text title
    • getColumnTitle

      @Nonnull public abstract String getColumnTitle(@Nonnull TColumnItem column)
      Retrieves a title for the specified column.
      Parameters:
      column - Column
      Returns:
      Localizable text title
    • isEntryReportOk

      public abstract boolean isEntryReportOk(@Nonnull TRow row, @Nonnull TColumnItem column, @Nonnull TEntryReport reportEntry)
      Verifies that the generated entry is correct.
      Parameters:
      row - Row
      column - Column
      reportEntry - Generated report entry
      Returns:
      true if the check passed
    • getReportInMatrix

      protected final String[][] getReportInMatrix()
    • getReportInCSV

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public String getReportInCSV()