Interface SearchErrorLookup

All Known Implementing Classes:
DefaultSearchErrorLookup

@ExperimentalApi public interface SearchErrorLookup
This class supports the storing and getting of renderable Errors, errors that we want to show regardless of plugin handling. The internal implementation is aware of the HTTP context and the acting user. The default timeout is 1 minute.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the error from queue for the user for the current HTTP context.
    void
    storeError(String errorI18n)
    Write to the error lookup.
  • Method Details

    • storeError

      void storeError(String errorI18n)
      Write to the error lookup. The HTTP context and the acting user will be recorded. If multiple error were stored at the same time with the same HTTP and user context, only one instance will be stored.
      Parameters:
      errorI18n - the error I18n String.
    • getError

      @Nullable String getError()
      Get the error from queue for the user for the current HTTP context. When an error is retrieved, it is removed from the lookup.
      Returns:
      the ErrorInfo, null if there are no error for this user and HTTP context or if the user is null.