com.yelp.nrtsearch.server.plugins.HighlighterPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server Show documentation

GRPC lucene server using near-real-time replication

There is a newer version: 1.0.0-beta.1

/*
 * Copyright 2023 Yelp Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.yelp.nrtsearch.server.plugins;

import com.yelp.nrtsearch.server.luceneserver.highlights.Highlighter;
import java.util.Collections;

/**
 * Plugin interface for providing custom highlighters. The plugins will be loaded at the startup
 * time of the {@link com.yelp.nrtsearch.server.grpc.LuceneServer}. The highlighter instances
 * provided from the getHighlighters will be responsible for handling the corresponding highlight
 * tasks (identified by name). Therefore, do not alter the instance object for any requests.
 */
public interface HighlighterPlugin {
  /**
   * Provides custom {@link Highlighter} implementations for registration with the {@link
   * com.yelp.nrtsearch.server.luceneserver.highlights.HighlighterService}.
   *
   * @return list of provided {@link Highlighter} implementations
   */
  default Iterable getHighlighters() {
    return Collections.emptyList();
  }
}