ClientScopeSynchronizerFactory.java

/*
 * Licensed to Luca Cavanna (the "Author") under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. Elastic Search licenses this
 * file to you 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 org.elasticsearch.shell.client;

/**
 * @author Luca Cavanna
 *
 * Factory for the {@link ClientScopeSynchronizer} that keeps the client in sync
 * with indexes and types available in the elasticsearch cluster
 * @param <ShellNativeClient> the shell native client to keep up-to-date
 */
public interface ClientScopeSynchronizerFactory<ShellNativeClient> {

    /**
     * Creates the {@link ClientScopeSynchronizer} that keeps the client up-to-date
     * for what concerns the name of the indexes and their types.
     *
     * @param shellNativeClient the shell native client to keep up-to-date
     * @return the {@link ClientScopeSynchronizer} that will keep up-to-date the shell native client
     */
    public ClientScopeSynchronizer<ShellNativeClient> createClientScopeSynchronizer(ShellNativeClient shellNativeClient);
}