Package com.broadleafcommerce.dataexchange.service.error

Class DataExchangeErrorProperties

java.lang.Object
com.broadleafcommerce.dataexchange.service.error.DataExchangeErrorProperties
@ConfigurationProperties(prefix="broadleaf.dataexchange.error-handling") public class DataExchangeErrorProperties extends Object

  • Constructor Details

    • DataExchangeErrorProperties

      public DataExchangeErrorProperties()

  • Method Details

    • isReturnStackTrace

      public boolean isReturnStackTrace()
      If true, the stack trace will be returned in the error response. This property should generally not be used in production environments.

    • isPrintStackTrace

      public boolean isPrintStackTrace()
      If true, the stack trace will be printed to the logs at error level. Note that this only controls printing the stack trace in the error handler. Other places may also print a stack trace, which could result in noisy logs.

    • isReturnRequestHeaders

      public boolean isReturnRequestHeaders()
      If true, attempt to return request headers in the error response. This property should generally not be used in production environments. "Authorization" headers will always be excluded.

    • getRequestHeaderWhitelist

      public Set<String> getRequestHeaderWhitelist()
      The request headers that are allowed to be returned in the error response. "Authorization" headers will always be excluded. if returnRequestHeaders is true.

    • isReturnResponseHeaders

      public boolean isReturnResponseHeaders()
      If true, attempt to return response headers in the error response. This property should generally not be used in production environments. "Authorization" headers will always be excluded.

    • getResponseHeaderBlacklist

      public Set<String> getResponseHeaderBlacklist()
      The response headers that are NOT allowed to be returned in the error response. Headers named "Authorization" will always be excluded and do not need to be defined.
      See Also:
      • returnResponseHeaders

    • setReturnStackTrace

      public void setReturnStackTrace(boolean returnStackTrace)
      If true, the stack trace will be returned in the error response. This property should generally not be used in production environments.

    • setPrintStackTrace

      public void setPrintStackTrace(boolean printStackTrace)
      If true, the stack trace will be printed to the logs at error level. Note that this only controls printing the stack trace in the error handler. Other places may also print a stack trace, which could result in noisy logs.

    • setReturnRequestHeaders

      public void setReturnRequestHeaders(boolean returnRequestHeaders)
      If true, attempt to return request headers in the error response. This property should generally not be used in production environments. "Authorization" headers will always be excluded.

    • setRequestHeaderWhitelist

      public void setRequestHeaderWhitelist(Set<String> requestHeaderWhitelist)
      The request headers that are allowed to be returned in the error response. "Authorization" headers will always be excluded. if returnRequestHeaders is true.

    • setReturnResponseHeaders

      public void setReturnResponseHeaders(boolean returnResponseHeaders)
      If true, attempt to return response headers in the error response. This property should generally not be used in production environments. "Authorization" headers will always be excluded.

    • setResponseHeaderBlacklist

      public void setResponseHeaderBlacklist(Set<String> responseHeaderBlacklist)
      The response headers that are NOT allowed to be returned in the error response. Headers named "Authorization" will always be excluded and do not need to be defined.
      See Also:
      • returnResponseHeaders

    • 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