io.quarkus.hibernate.search.orm.elasticsearch.SearchExtension Maven / Gradle / Ivy

Go to download
package io.quarkus.hibernate.search.orm.elasticsearch;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import jakarta.enterprise.util.AnnotationLiteral;
import jakarta.inject.Qualifier;

import io.quarkus.hibernate.orm.PersistenceUnit;

/**
 * CDI qualifier for beans representing an "extension" of Hibernate Search in a given persistence unit,
 * i.e. beans injected into Hibernate Search as part of its configuration.
 * 
 * See the reference documentation for information about extensions that supports this annotation.
 */
@Target({ TYPE, FIELD, METHOD, PARAMETER })
@Retention(RUNTIME)
@Documented
@Qualifier
@Repeatable(SearchExtension.List.class)
public @interface SearchExtension {

    /**
     * @return The name of the persistence unit that the qualified bean should be assigned to.
     */
    String persistenceUnit() default PersistenceUnit.DEFAULT;

    /**
     * @return The name of the Hibernate Search backend that the qualified bean should be assigned to.
     */
    String backend() default "";

    /**
     * @return The name of the Hibernate Search index that the qualified bean should be assigned to.
     */
    String index() default "";

    class Literal
            extends AnnotationLiteral
            implements SearchExtension {

        private final String persistenceUnit;
        private final String backend;
        private final String index;

        public Literal(String persistenceUnit, String backend, String index) {
            this.persistenceUnit = persistenceUnit;
            this.backend = backend;
            this.index = index;
        }

        @Override
        public String persistenceUnit() {
            return persistenceUnit;
        }

        @Override
        public String backend() {
            return backend;
        }

        @Override
        public String index() {
            return index;
        }
    }

    @Target({ TYPE, FIELD, METHOD, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        SearchExtension[] value();
    }
}