Interface CollaboratorPayload


  • public interface CollaboratorPayload
    This interface represents a Burp Collaborator payload.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> customData()
      Return custom data from the payload.
      InteractionId id()
      Returns the payload's interaction id.
      java.util.Optional<CollaboratorServer> server()
      Returns an optional instance of CollaboratorServer describing the server location for this payload.
      java.lang.String toString()
      Returns a string containing the payload.
    • Method Detail

      • id

        InteractionId id()
        Returns the payload's interaction id.
        Returns:
        The interaction id of the payload.
      • customData

        java.util.Optional<java.lang.String> customData()
        Return custom data from the payload.
        Returns:
        The payload's custom data.
      • server

        java.util.Optional<CollaboratorServer> server()
        Returns an optional instance of CollaboratorServer describing the server location for this payload. If the payload was generated without the server location this method will return an empty Optional.
        Returns:
        Details of the collaborator server referenced in the payload or empty if the payload was generated without the server location.
      • toString

        java.lang.String toString()
        Returns a string containing the payload.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The payload string.