Package tenapull.data.deserialize

Interface SummarySerializer.Summary<S extends DbPojo,​D extends DbPojo>

Type Parameters:
S - The general-info ("summary") entity from the DB
D - The more detailed-info ("details") entity from the DB
All Known Implementing Classes:
HostVulnerabilityOutput.ScanHostSummary, HostVulnerabilityOutput.ScanSummary
Enclosing class:
SummarySerializer<S extends DbPojo,​D extends DbPojo>
public static interface SummarySerializer.Summary<S extends DbPojo,​D extends DbPojo>
The interface that must be implemented by the summary wrappers being serialized

  • Method Summary

    Modifier and Type Method Description
    D getDetails()
    Gets the "details" or "info" entity from the DB
    default java.lang.String getDetailsKey()
    Get the key to be used for the "details" entity.
    java.lang.String getName()
    Get the name of the entity being summarized
    default java.lang.Integer getOptionalId()
    Optionally returns an Integer id to be serialized as the first entry in the summary wrapper.
    ExtraJson getOther()
    Get any extra json to be included, or null if there is none
    S getSummary()
    Gets the "summary" entity from the DB

  • Method Details

    • getSummary

      S getSummary()
      Gets the "summary" entity from the DB
      Returns:
      the summary entity

    • getDetails

      D getDetails()
      Gets the "details" or "info" entity from the DB
      Returns:
      the details entity

    • getOther

      ExtraJson getOther()
      Get any extra json to be included, or null if there is none
      Returns:
      any ExtraJson to be included

    • getName

      java.lang.String getName()
      Get the name of the entity being summarized
      Returns:
      the name of the entity being summarized

    • getDetailsKey

      default java.lang.String getDetailsKey()
      Get the key to be used for the "details" entity. By default it is "info"
      Returns:
      the key to be used for the details entity

    • getOptionalId

      default java.lang.Integer getOptionalId()
      Optionally returns an Integer id to be serialized as the first entry in the summary wrapper. If null is returned, the id field is omitted
      Returns:
      an id to be serialized, or null if omitting the id