Package burp.api.montoya.collaborator

Interface InteractionFilter

  • public interface InteractionFilter
    This interface provides a filtering mechanism for use when retrieving interactions from the Burp Collaborator server. Helper methods are provided to create filters based on the interaction id and the payload.

    • Method Detail

      • interactionIdFilter

        static InteractionFilter interactionIdFilter​(java.lang.String id)
        This method constructs an InteractionFilter that matches any interaction with the specified interaction id.
        Parameters:
        id - The interaction id.
        Returns:
        true if the interaction has the specified id, false if not.

      • interactionPayloadFilter

        static InteractionFilter interactionPayloadFilter​(java.lang.String payload)
        This method constructs an InteractionFilter that matches any interaction with the specified payload.
        Parameters:
        payload - The payload.
        Returns:
        true if the interaction has the specified payload, false if not.

      • matches

        boolean matches​(CollaboratorServer server,
                Interaction interaction)
        This method will be called for each interaction retrieved from the Collaborator server and determines whether the interaction should be included in the list of interactions returned.
        Parameters:
        server - The collaborator server that received the interaction.
        interaction - The interaction details.
        Returns:
        true if the interaction should be included, false if not.