All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.arakelian.elastic.utils.ElasticClientUtils Maven / Gradle / Ivy

    /*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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 com.arakelian.elastic.utils;

import java.io.IOException;
import java.io.UncheckedIOException;
import java.net.SocketTimeoutException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.arakelian.elastic.DefaultOkHttpElasticApiFactory;
import com.arakelian.elastic.ElasticClient;
import com.arakelian.elastic.ElasticHttpException;
import com.arakelian.elastic.OkHttpElasticClient;
import com.arakelian.elastic.Views.Elastic.Version5;
import com.arakelian.elastic.Views.Elastic.Version5.Version52;
import com.arakelian.elastic.Views.Elastic.Version5.Version53;
import com.arakelian.elastic.Views.Elastic.Version5.Version54;
import com.arakelian.elastic.Views.Elastic.Version5.Version55;
import com.arakelian.elastic.Views.Elastic.Version5.Version56;
import com.arakelian.elastic.Views.Elastic.Version6;
import com.arakelian.elastic.Views.Elastic.Version6.Version61;
import com.arakelian.elastic.Views.Elastic.Version6.Version62;
import com.arakelian.elastic.Views.Elastic.Version6.Version63;
import com.arakelian.elastic.Views.Elastic.Version6.Version64;
import com.arakelian.elastic.Views.Elastic.Version6.Version65;
import com.arakelian.elastic.Views.Elastic.Version6.Version66;
import com.arakelian.elastic.Views.Elastic.Version6.Version67;
import com.arakelian.elastic.Views.Elastic.Version6.Version68;
import com.arakelian.elastic.Views.Elastic.Version7;
import com.arakelian.elastic.Views.Elastic.Version7.Version71;
import com.arakelian.elastic.Views.Elastic.Version7.Version72;
import com.arakelian.elastic.Views.Elastic.Version7.Version73;
import com.arakelian.elastic.model.About;
import com.arakelian.elastic.model.ImmutableIndex;
import com.arakelian.elastic.model.Index;
import com.arakelian.elastic.model.Index.WithoutNameSerializer;
import com.arakelian.elastic.model.VersionComponents;
import com.arakelian.jackson.utils.JacksonUtils;
import com.arakelian.retry.RetryException;
import com.arakelian.retry.Retryer;
import com.arakelian.retry.RetryerBuilder;
import com.arakelian.retry.StopStrategies;
import com.arakelian.retry.StopStrategy;
import com.arakelian.retry.WaitStrategies;
import com.arakelian.retry.WaitStrategy;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.google.common.base.Preconditions;
import com.google.common.base.Predicate;

import okhttp3.OkHttpClient;
import retrofit2.Response;

public class ElasticClientUtils {
    /**
     * Determines if an {@link IOException} is suitable for retry. Adapted from Apache Commons IO's
     * DefaultHttpMethodRetryHandler.
     */
    public static class RetryIoException implements Predicate {
        @Override
        public boolean apply(final Throwable exception) {
            if (findCause(exception, SocketTimeoutException.class) != null) {
                // Retry if the server dropped connection on us
                return true;
            }

            final ElasticHttpException cause = findCause(exception, ElasticHttpException.class);
            if (cause != null) {
                return retryIfResponse(cause.getStatusCode());
            }

            // otherwise do not retry
            return false;
        }

        private  T findCause(final Throwable exception, final Class type) {
            if (exception == null) {
                return null;
            }
            if (type.isInstance(exception)) {
                return type.cast(exception);
            }
            return findCause(exception.getCause(), type);
        }
    }

    private static final Logger LOGGER = LoggerFactory.getLogger(ElasticClientUtils.class);

    public static final String DEFAULT_TIMEOUT = "30s";

    public static void configure(final ObjectMapper mapper, final VersionComponents version) {
        if (version != null && !version.isEmpty()) {
            final Class view = getJsonView(version);
            JacksonUtils.withView(mapper, view);
        }
    }

    public static void configureIndexSerialization(final ObjectMapper mapper) {
        JsonSerializer delegate;
        try {
            delegate = mapper.copy().getSerializerProviderInstance()
                    .findTypedValueSerializer(ImmutableIndex.class, false, null);
        } catch (final JsonMappingException e) {
            throw new UncheckedIOException(e);
        }

        final SimpleModule module = new SimpleModule();
        module.addSerializer(Index.class, new WithoutNameSerializer(delegate));
        mapper.registerModule(module);
    }

    public static ElasticClient createElasticClient(
            final String elasticUrl,
            final OkHttpClient client,
            final ObjectMapper objectMapper,
            final VersionComponents version) {

        return new OkHttpElasticClient(elasticUrl, new DefaultOkHttpElasticApiFactory(client), objectMapper,
                version);
    }

    public static  Retryer createElasticRetryer() {
        final StopStrategy stopStrategy = StopStrategies.stopAfterDelay(10, TimeUnit.MINUTES);
        final WaitStrategy waitStrategy = WaitStrategies.exponentialWait(30, TimeUnit.SECONDS);
        return createElasticRetryer(stopStrategy, waitStrategy);
    }

    public static  Retryer createElasticRetryer(
            final StopStrategy stopStrategy,
            final WaitStrategy waitStrategy) {

        return RetryerBuilder. newBuilder() //
                .retryIfException(new RetryIoException()) //
                .withStopStrategy(Preconditions.checkNotNull(stopStrategy, "stopStrategy must be non-null")) //
                .withWaitStrategy(Preconditions.checkNotNull(waitStrategy, "waitStrategy must be non-null")) //
                .build();
    }

    /**
     * Returns true if call to Elastic should be retried.
     *
     * 
      
     * 
    • HTTP 1xx are informational, and retry will have no benefit.
      • 
     * 
    • HTTP 2xx are success, and retry makes no sense.
      • 
     * 
    • HTTP 3xx are redirect message, and should be handled by Retrofit/OkHttp3 client.
      • 
     * 
    • HTTP 4xx are bad client requests, except for status 429 (TOO_MANY_REQUESTS).
      • 
     * 
    • HTTP 5xx are server errors, and retry is worthwhile
      • 
     * 
    
     *
     * @param status
     *            status code from HTTP response
     * @return true if call to Elastic should be retried
     */
    public static boolean retryIfResponse(final int status) {
        // note: status 429 is TOO_MANY_REQUESTS and it is a server exception that should be retried
        return status == 429 || status >= 500;
    }

    /**
     * Returns true if call to Elastic should be retried.
     *
     * @param response
     *            response from last call to Elastic
     * @return true if call to Elastic should be retried.
     */
    public static boolean retryIfResponse(final Response response) {
        return response != null ? ElasticClientUtils.retryIfResponse(response.code()) : false;
    }

    public static About waitForElasticReady(
            final ElasticClient elasticClient,
            final long timeout,
            final TimeUnit unit) {
        final Retryer retryer = RetryerBuilder. newBuilder() //
                .retryIfException() //
                .withStopStrategy(StopStrategies.stopAfterDelay(timeout, unit)) //
                .withWaitStrategy(WaitStrategies.fixedWait(5, TimeUnit.SECONDS)) //
                .build();

        // wait for elastic
        try {
            final About info = retryer.call(() -> {
                return elasticClient.about();
            });
            return info;
        } catch (final ExecutionException e) {
            LOGGER.warn("Unable to retrieve Elastic information after {} {}", timeout, unit, e);
            return null;
        } catch (final RetryException e) {
            LOGGER.warn("Unable to retrieve Elastic information after {} {}", timeout, unit, e);
            return null;
        }
    }

    private static Class getJsonView(final VersionComponents version) {
        switch (version.getMajor()) {
        case 5:
            switch (version.getMinor()) {
            case 2:
                return Version52.class;
            case 3:
                return Version53.class;
            case 4:
                return Version54.class;
            case 5:
                return Version55.class;
            case 6:
                return Version56.class;
            default:
                return Version5.class;
            }
        case 6:
            switch (version.getMinor()) {
            case 1:
                return Version61.class;
            case 2:
                return Version62.class;
            case 3:
                return Version63.class;
            case 4:
                return Version64.class;
            case 5:
                return Version65.class;
            case 6:
                return Version66.class;
            case 7:
                return Version67.class;
            case 8:
                return Version68.class;
            default:
                return Version6.class;
            }
        case 7:
            switch (version.getMinor()) {
            case 1:
                return Version71.class;
            case 2:
                return Version72.class;
            case 3:
                return Version73.class;
            default:
                return Version7.class;
            }
        default:
            throw new IllegalStateException("Unsupported version of Elasticsearch: " + version);
        }
    }

    private ElasticClientUtils() {
        // utility class
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy