Package com.broadleafcommerce.resource.security.xss.service.dto

Class XSSRequestParameterProcessingResponse

java.lang.Object
com.broadleafcommerce.resource.security.xss.service.dto.XSSRequestParameterProcessingResponse
public class XSSRequestParameterProcessingResponse extends Object
A response object returned from the XSSRequestProcessingService after processing a request parameter and its value(s).
Author:
Samarth Dhruva (samarthd)

  • Constructor Details

    • XSSRequestParameterProcessingResponse

      public XSSRequestParameterProcessingResponse()

  • Method Details

    • getPerformedOperationType

      public String getPerformedOperationType()
      Reports the type of operation that was performed on the input.

    • isError

      public boolean isError()
      If validation was performed, this reports if an XSS violation was detected.

    • getSanitizedParameterName

      @Nullable public String getSanitizedParameterName()
      The request parameter name after sanitization. This should be set either in the case where sanitization was performed, or in the case where error is true (so the error message can use the sanitized name).

    • getSanitizedParameterValues

      @Nullable public String[] getSanitizedParameterValues()
      The request parameter value(s) after sanitization. This should be set in the case where sanitization was performed.

    • setPerformedOperationType

      public void setPerformedOperationType(String performedOperationType)
      Reports the type of operation that was performed on the input.

    • setError

      public void setError(boolean error)
      If validation was performed, this reports if an XSS violation was detected.

    • setSanitizedParameterName

      public void setSanitizedParameterName(@Nullable String sanitizedParameterName)
      The request parameter name after sanitization. This should be set either in the case where sanitization was performed, or in the case where error is true (so the error message can use the sanitized name).

    • setSanitizedParameterValues

      public void setSanitizedParameterValues(@Nullable String[] sanitizedParameterValues)
      The request parameter value(s) after sanitization. This should be set in the case where sanitization was performed.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object