001/*
002 * (C) Copyright 2015-2020 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     <a href="mailto:grenard@nuxeo.com">Guillaume Renard</a>
018 *
019 */
020
021package org.nuxeo.elasticsearch.http.readonly.filter;
022
023import org.json.JSONException;
024import org.nuxeo.ecm.core.api.CoreSession;
025
026public interface SearchRequestFilter {
027
028    String getPayload() throws JSONException;
029
030    /**
031     * @deprecated since 11.4, types have been removed since Elasticsearch 7.x, use
032     *             {@link #init(CoreSession, String, String, String)} instead
033     */
034    @Deprecated(since = "11.4", forRemoval = true)
035    default void init(CoreSession session, String indices, String types, String rawQuery, String payload) {
036        init(session, indices, rawQuery, payload);
037    }
038
039    /**
040     * @since 11.4
041     */
042    void init(CoreSession session, String indices, String rawQuery, String payload);
043
044    String getUrl();
045
046    String getIndices();
047
048    /**
049     * @deprecated since 11.4, types have been removed since Elasticsearch 7.x
050     */
051    @Deprecated(since = "11.4", forRemoval = true)
052    String getTypes();
053
054}