Package org.elasticsearch.rest

Interface RestRequestFilter

All Known Implementing Classes:
RestReloadSecureSettingsAction
public interface RestRequestFilter
Identifies an object that supplies a filter for the content of a RestRequest. This interface should be implemented by a RestHandler that expects there will be sensitive content in the body of the request such as a password

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getFilteredFields()
    The list of fields that should be filtered.
    default RestRequest
    getFilteredRequest(RestRequest restRequest)
    Wraps the RestRequest and returns a version that provides the filtered content

  • Method Details

    • getFilteredRequest

      default RestRequest getFilteredRequest(RestRequest restRequest) throws IOException
      Wraps the RestRequest and returns a version that provides the filtered content
      Throws:
      IOException

    • getFilteredFields

      Set<String> getFilteredFields()
      The list of fields that should be filtered. This can be a dot separated pattern to match sub objects and also supports wildcards