* This will be used by the **automatic docs**.
    * It will also be used by automatic client code generation tools.

But most importantly:

* It will **limit and filter** the output data to what is defined in the return type.
    * This is particularly important for **security**, we'll see more of that below.

## `response_model` Parameter { #response-model-parameter }

        "tokenizer" : "fess_japanese_normal",
        "filter" : ["reading_form"]
      },
      "reading_term_analyzer" : {
        "type" : "custom",
        "tokenizer" : "fess_japanese_normal"
      },
      "normalize_analyzer" : {
        "type" : "custom",
        "tokenizer" : "keyword",
        "char_filter" : ["mapping_char"],
        "filter" : ["lowercase"]
      },
      "contents_analyzer" : {

        }
    }

    public void filtered(FilteredCall<RelatedContentCQ, RelatedContentCQ> filteredLambda) {
        filtered(filteredLambda, null);
    }

    public void filtered(FilteredCall<RelatedContentCQ, RelatedContentCQ> filteredLambda, ConditionOptionCall<BoolQueryBuilder> opLambda) {
        bool((must, should, mustNot, filter) -> {
            filteredLambda.callback(must, filter);
        }, opLambda);
    }

     */
    CloseableIterator<SmbResource> children(ResourceNameFilter filter) throws CIFSException;

    /**
     * Fetch children matching the given filter.
     *
     * @param filter
     *            filter acting on SmbResource instances
     * @return an iterator over the child resources

    void accept_returnsTrueForDirectory_andVerifiesInteraction() throws Exception {
        // Arrange: filter that accepts directories only
        SmbFileFilter filter = f -> f.isDirectory();
        when(smbFile.isDirectory()).thenReturn(true);

        // Act
        boolean result = filter.accept(smbFile);

        // Assert
        assertTrue(result, "Directory should be accepted");

      },
      "contents_analyzer_pl" : {
        "type" : "custom",
        "tokenizer" : "standard",
        "char_filter" : ["mapping_char"],
        "filter" : ["lowercase", "content_length_filter", "limit_token_count_filter"]
      },
      "contents_reading_analyzer_pl" : {
        "type" : "custom",
        "tokenizer" : "standard",
        "char_filter" : ["mapping_char"],

        ScopeArtifactFilter filter = new ScopeArtifactFilter(Artifact.SCOPE_TEST);

        assertTrue(filter.include(newArtifact(Artifact.SCOPE_COMPILE)));
        assertTrue(filter.include(newArtifact(Artifact.SCOPE_SYSTEM)));
        assertTrue(filter.include(newArtifact(Artifact.SCOPE_PROVIDED)));
        assertTrue(filter.include(newArtifact(Artifact.SCOPE_RUNTIME)));
        assertTrue(filter.include(newArtifact(Artifact.SCOPE_TEST)));

                }
                try (InputStream in = Files.newInputStream(tempFile)) {
                    out.write(in);
                }
            } finally {
                Files.delete(tempFile);
            }
        });
    }

    // -----------------------------------------------------

        final EncodingFilter filter = new EncodingFilter();
        Map<String, String[]> paramMap;

        paramMap = filter.parseQueryString("a=", "UTF-8");
        assertEquals(1, paramMap.size());
        assertEquals("", paramMap.get("a")[0]);

        paramMap = filter.parseQueryString("a", "UTF-8");
        assertEquals(1, paramMap.size());
        assertEquals("", paramMap.get("a")[0]);

        // Verify iteration
        assertTrue(iterator.hasNext());
        assertSame(resource, iterator.next());
        assertFalse(iterator.hasNext());

        // With filter, resource should be closed due to try-with-resources
        verify(filter).accept(resource);
        verify(resource).close();
    }

    @Test
    @DisplayName("Iterator with rejecting filter - finds next acceptable")