com.hp.autonomy.searchcomponents.idol.configuration.AciServiceRetriever Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of haven-search-components-idol Show documentation

The newest version!

/*
 * Copyright 2015 Open Text.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Open Text and its affiliates
 * and licensors ("Open Text") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Open Text shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */

package com.hp.autonomy.searchcomponents.idol.configuration;

import com.autonomy.aci.client.services.AciService;
import com.hp.autonomy.searchcomponents.core.search.QueryRequest;
import org.springframework.beans.factory.annotation.Qualifier;

/**
 * Retrieves {@link AciService} object for connecting to either QMS or Content,
 * depending upon which is configured/required
 */
public interface AciServiceRetriever {
    /**
     * The bean name of the default implementation.
     * Use this in an {@link Qualifier} tag to access this implementation via autowiring.
     */
    String ACI_SERVICE_RETRIEVER_BEAN_NAME = "aciServiceRetriever";

    /**
     * Whether or not a qms server is configured
     *
     * @return Whether or not a qms server is configured
     */
    boolean qmsEnabled();

    /**
     * Retrieves object for connecting to either QMS or Content
     *
     * @param queryType if raw, will retrieve Content AciService regardless; otherwise will retrieve QMS AciService if available
     * @return the QMS AciService if required and configured, otherwise the Content AciService
     */
    AciService getAciService(final QueryRequest.QueryType queryType);
}